eloquent/endec API
Class

Eloquent\Endec\Base32\Base32EncodeTransform

class Base32EncodeTransform extends AbstractBase32EncodeTransform

Encodes data using base32 encoding.

Methods

tuple<string,integer,mixed> transform(string $data, mixed $context, boolean $isEnd = false)

Transform the supplied data.

 from AbstractBase32EncodeTransform
integer bufferSize()

Get the buffer size.

 from AbstractBase32EncodeTransform
static BufferedTransformInterface instance()

Get the static instance of this transform.
__construct()

Construct a new base32 encode transform.

Details

in AbstractBase32EncodeTransform at line 55
public tuple<string,integer,mixed> transform(string $data, mixed $context, boolean $isEnd = false)

Transform the supplied data.

This method may transform only part of the supplied data. The return value includes information about how much data was actually consumed. The transform can be forced to consume all data by passing a boolean true as the $isEnd argument.

The $context argument will initially be null, but any value assigned to this variable will persist until the stream transformation is complete. It can be used as a place to store state, such as a buffer.

It is guaranteed that this method will be called with $isEnd = true once, and only once, at the end of the stream transformation.

Parameters

string $data The data to transform.
mixed $context An arbitrary context value.
boolean $isEnd True if all supplied data must be transformed.

Return Value

tuple<string,integer,mixed> A 3-tuple of the transformed data, the number of bytes consumed, and any resulting error.

in AbstractBase32EncodeTransform at line 113
public integer bufferSize()

Get the buffer size.

This method is used to determine how much input is typically required before output can be produced. This can provide performance benefits by avoiding excessive method calls.

Return Value

integer The buffer size.

at line 28
static public BufferedTransformInterface instance()

Get the static instance of this transform.

Return Value

BufferedTransformInterface The transform.

at line 40
public __construct()

Construct a new base32 encode transform.