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

BufferJsonEncoder

class BufferJsonEncoder extends AbstractJsonEncoder (View source)

Encodes the given value as JSON and returns encoding result step by step.

Methods

__construct(mixed $value)

AbstractJsonEncoder constructor.

from AbstractJsonEncoder
$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 JSON encoded in the current step.

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)

Writes the JSON output to the step buffer.

string
encode()

Encodes the entire value as JSON and returns the value as a string.

Details

in AbstractJsonEncoder at line 54
__construct(mixed $value)

AbstractJsonEncoder constructor.

Parameters

mixed $value The value to encode as JSON

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 52
mixed current()

Returns the JSON encoded in the current step.

Return Value

mixed The current value or state from the encoder

at line 33
rewind()

Returns the JSON encoding to the beginning.

at line 41
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 62
protected void write(string $string, int $token)

Writes the JSON output to the step buffer.

Parameters

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

Return Value

void

at line 21
string encode()

Encodes the entire value as JSON and returns the value as a string.

Return Value

string The encoded JSON