Index
A
- AbstractJsonEncoder — Class in namespace Violet\StreamingJsonEncoder
- Abstract encoder for encoding JSON iteratively.
B
- BufferJsonEncoder — Class in namespace Violet\StreamingJsonEncoder
- Encodes the given value as JSON and returns encoding result step by step.
C
- AbstractJsonEncoder::current() — Method in class AbstractJsonEncoder
- Returns the current value or state from the encoder.
- BufferJsonEncoder::current() — Method in class BufferJsonEncoder
- Returns the JSON encoded in the current step.
- JsonStream::close() — Method in class JsonStream
- Frees the JSON encoder from memory and prevents further reading from the JSON stream.
- StreamJsonEncoder::current() — Method in class StreamJsonEncoder
- Returns the bytes written in the last step or null if the encoder is not in valid state.
D
- JsonStream::detach() — Method in class JsonStream
- Detaches the underlying PHP resource from the stream and returns it.
E
- BufferJsonEncoder::encode() — Method in class BufferJsonEncoder
- Encodes the entire value as JSON and returns the value as a string.
- EncodingException — Class in namespace Violet\StreamingJsonEncoder
- Exception that gets thrown when error occurs in JSON encoding and the encoder cannot continue.
- JsonStream::eof() — Method in class JsonStream
- Tells if there are no more bytes to read from the JSON stream.
- StreamJsonEncoder::encode() — Method in class StreamJsonEncoder
- Encodes the entire value into JSON and returns the number bytes.
G
- AbstractJsonEncoder::getErrors() — Method in class AbstractJsonEncoder
- Returns the list of errors that occurred during the last encoding process.
- AbstractJsonEncoder::getValueStack() — Method in class AbstractJsonEncoder
- Returns the current encoding value stack.
- JsonStream::getSize() — Method in class JsonStream
- Returns the total size of the JSON stream.
- JsonStream::getContents() — Method in class JsonStream
- Returns the remaining bytes from the JSON stream.
- JsonStream::getMetadata() — Method in class JsonStream
- Returns the metadata related to the JSON stream.
I
- JsonStream::isSeekable() — Method in class JsonStream
- Tells if the JSON stream is seekable or not.
- JsonStream::isWritable() — Method in class JsonStream
- Tells if the JSON stream is writable or not.
- JsonStream::isReadable() — Method in class JsonStream
- Tells if the JSON stream is readable or not.
J
- JsonStream — Class in namespace Violet\StreamingJsonEncoder
- Provides a http stream interface for encoding JSON.
- JsonToken — Class in namespace Violet\StreamingJsonEncoder
- List of JSON tokens outputted by the encoder.
K
- AbstractJsonEncoder::key() — Method in class AbstractJsonEncoder
- Returns the current number of step in the encoder.
N
- AbstractJsonEncoder::next() — Method in class AbstractJsonEncoder
- Iterates the next token or tokens to the output stream.
- BufferJsonEncoder::next() — Method in class BufferJsonEncoder
- Iterates the next token or tokens to the output stream.
- StreamJsonEncoder::next() — Method in class StreamJsonEncoder
- Iterates the next token or tokens to the output stream.
R
- AbstractJsonEncoder::rewind() — Method in class AbstractJsonEncoder
- Returns the JSON encoding to the beginning.
- AbstractJsonEncoder::resolveValue() — Method in class AbstractJsonEncoder
- Resolves the actual value of any given value that is about to be processed.
- BufferJsonEncoder::rewind() — Method in class BufferJsonEncoder
- Returns the JSON encoding to the beginning.
- JsonStream::rewind() — Method in class JsonStream
- Seeks the beginning of the JSON stream.
- JsonStream::read() — Method in class JsonStream
- Returns the given number of bytes from the JSON stream.
- StreamJsonEncoder::rewind() — Method in class StreamJsonEncoder
- Returns the JSON encoding to the beginning.
S
- AbstractJsonEncoder::setOptions() — Method in class AbstractJsonEncoder
- Sets the JSON encoding options.
- AbstractJsonEncoder::setIndent() — Method in class AbstractJsonEncoder
- Sets the indent for the JSON output.
- JsonStream::seek() — Method in class JsonStream
- Seeks the given cursor position in the JSON stream.
- StreamJsonEncoder — Class in namespace Violet\StreamingJsonEncoder
- Encodes value into JSON and directly echoes it or passes it to a stream.
T
- JsonStream::tell() — Method in class JsonStream
- Returns the current position of the cursor in the JSON stream.
V
- AbstractJsonEncoder::valid() — Method in class AbstractJsonEncoder
- Tells if the encoder has a valid current state.
W
- AbstractJsonEncoder::write() — Method in class AbstractJsonEncoder
- Actually handles the writing of the given token to the output stream.
- BufferJsonEncoder::write() — Method in class BufferJsonEncoder
- Writes the JSON output to the step buffer.
- JsonStream::write() — Method in class JsonStream
- Writes the given bytes to the JSON stream.
- StreamJsonEncoder::write() — Method in class StreamJsonEncoder
- Echoes to given string or passes it to the stream callback.
_
- AbstractJsonEncoder::__construct() — Method in class AbstractJsonEncoder
- AbstractJsonEncoder constructor.
- JsonStream::__construct() — Method in class JsonStream
- JsonStream constructor.
- JsonStream::__toString() — Method in class JsonStream
- Returns the entire JSON stream as a string.
- StreamJsonEncoder::__construct() — Method in class StreamJsonEncoder
- StreamJsonEncoder constructor.