1. class
  2. Violet
  3. \
  4. StreamingJsonEncoder
  5. \
  6. StreamJsonEncoder

StreamJsonEncoder

class StreamJsonEncoder extends AbstractJsonEncoder (View source)

Encodes value into JSON and directly echoes it or passes it to a stream.

Methods

__construct(mixed $value, callable $stream = null)

StreamJsonEncoder constructor.

$this
setOptions(int $options)

Sets the JSON encoding options.

from AbstractJsonEncoder
$this
setIndent(string|int $indent)

Sets the indent for the JSON output.

from AbstractJsonEncoder
string[]
getErrors()

Returns the list of errors that occurred during the last encoding process.

from AbstractJsonEncoder
array
getValueStack()

Returns the current encoding value stack.

from AbstractJsonEncoder
int|null
key()

Returns the current number of step in the encoder.

from AbstractJsonEncoder
bool
valid()

Tells if the encoder has a valid current state.

from AbstractJsonEncoder
mixed
current()

Returns the bytes written in the last step or null if the encoder is not in valid state.

rewind()

Returns the JSON encoding to the beginning.

next()

Iterates the next token or tokens to the output stream.

mixed
resolveValue(mixed $value)

Resolves the actual value of any given value that is about to be processed.

from AbstractJsonEncoder
void
write(string $string, int $token)

Echoes to given string or passes it to the stream callback.

int
encode()

Encodes the entire value into JSON and returns the number bytes.

Details

at line 33
__construct(mixed $value, callable $stream = null)

StreamJsonEncoder constructor.

If a callable is given as the second argument, the callable will be called with two arguments. The first argument is the JSON string to output and the second argument is the type of the token being outputted.

If no second parameter is passed to the constructor, then the encoder will simply output the json using an echo statement.

Parameters

mixed $value The value to encode as JSON
callable $stream An optional stream to pass the output or null to echo it

in AbstractJsonEncoder at line 68
$this setOptions(int $options)

Sets the JSON encoding options.

Parameters

int $options The JSON encoding options that are used by json_encode

Return Value

$this Returns self for call chaining

Exceptions

RuntimeException If changing encoding options during encoding operation

in AbstractJsonEncoder at line 84
$this setIndent(string|int $indent)

Sets the indent for the JSON output.

Parameters

string|int $indent A string to use as indent or the number of spaces

Return Value

$this Returns self for call chaining

Exceptions

RuntimeException If changing indent during encoding operation

in AbstractJsonEncoder at line 98
string[] getErrors()

Returns the list of errors that occurred during the last encoding process.

Return Value

string[] List of errors that occurred during encoding

in AbstractJsonEncoder at line 107
protected array getValueStack()

Returns the current encoding value stack.

Return Value

array The current encoding value stack

in AbstractJsonEncoder at line 126
int|null key()

Returns the current number of step in the encoder.

Return Value

int|null The current step number as integer or null if the current state is not valid

in AbstractJsonEncoder at line 137
bool valid()

Tells if the encoder has a valid current state.

Return Value

bool True if the iterator has a valid state, false if not

at line 75
mixed current()

Returns the bytes written in the last step or null if the encoder is not in valid state.

Return Value

mixed The current value or state from the encoder

at line 56
rewind()

Returns the JSON encoding to the beginning.

at line 64
next()

Iterates the next token or tokens to the output stream.

in AbstractJsonEncoder at line 261
protected mixed resolveValue(mixed $value)

Resolves the actual value of any given value that is about to be processed.

Parameters

mixed $value The value to resolve

Return Value

mixed The resolved value

at line 85
protected void write(string $string, int $token)

Echoes to given string or passes it to the stream callback.

Parameters

string $string The given token to write
int $token The type of the token

Return Value

void

at line 44
int encode()

Encodes the entire value into JSON and returns the number bytes.

Return Value

int Returned the number of bytes outputted