\Pydio\Core\Http\ResponseSerializableResponseStream

Class SerializableResponseStream Transport stream for various data types that can be serialized to various formats

Summary

Methods
Properties
Constants
__construct()
setSerializer()
supportsSerializer()
addChunk()
getChunks()
getContents()
__toString()
close()
detach()
getSize()
tell()
eof()
isSeekable()
seek()
rewind()
isWritable()
write()
isReadable()
read()
getMetadata()
No public properties found
SERIALIZER_TYPE_XML
SERIALIZER_TYPE_JSON
SERIALIZER_TYPE_CLI
serializeData()
$serializer
$serializerContext
$data
$serializedContent
N/A
No private methods found
$streamStatus
N/A

Constants

SERIALIZER_TYPE_XML

SERIALIZER_TYPE_XML

SERIALIZER_TYPE_JSON

SERIALIZER_TYPE_JSON

SERIALIZER_TYPE_CLI

SERIALIZER_TYPE_CLI

Properties

$serializer

$serializer : string

Type

string

$serializerContext

$serializerContext : array

Type

array — Additional context variable depending on serializer

$serializedContent

$serializedContent : string

Type

string — SerializedContent

$streamStatus

$streamStatus : 

Type

Methods

setSerializer()

setSerializer(string  $serializer, array  $context = null) 

Parameters

string $serializer

SERIALIZER_TYPE_XML|SERIALIZER_TYPE_JSON|SERIALIZER_TYPE_CLI

array $context

Additional data for serializer

supportsSerializer()

supportsSerializer(  $serializer) : boolean

Test if at least one chunk of data can be serialized using this format

Parameters

$serializer

Returns

boolean

getContents()

getContents() : string

Returns

string

__toString()

__toString() : string

Reads all data from the stream into a string, from the beginning to end.

This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.

Warning: This could attempt to load a large amount of data into memory.

This method MUST NOT raise an exception in order to conform with PHP's string casting operations.

Returns

string

close()

close() : void

Closes the stream and any underlying resources.

detach()

detach() : resource|null

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

Returns

resource|null —

Underlying PHP stream, if any

getSize()

getSize() : integer|null

Get the size of the stream if known.

Returns

integer|null —

Returns the size in bytes if known, or null if unknown.

tell()

tell() : integer

Returns the current position of the file read/write pointer

Throws

\RuntimeException

on error.

Returns

integer —

Position of the file pointer

eof()

eof() : boolean

Returns true if the stream is at the end of the stream.

Returns

boolean

isSeekable()

isSeekable() : boolean

Returns whether or not the stream is seekable.

Returns

boolean

seek()

seek(integer  $offset, integer  $whence = SEEK_SET) 

Seek to a position in the stream.

Parameters

integer $offset

Stream offset

integer $whence

Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset.

Throws

\RuntimeException

on failure.

rewind()

rewind() 

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

Throws

\RuntimeException

on failure.

isWritable()

isWritable() : boolean

Returns whether or not the stream is writable.

Returns

boolean

write()

write(string  $string) : integer

Write data to the stream.

Parameters

string $string

The string that is to be written.

Throws

\RuntimeException

on failure.

Returns

integer —

Returns the number of bytes written to the stream.

isReadable()

isReadable() : boolean

Returns whether or not the stream is readable.

Returns

boolean

read()

read(integer  $length) : string

Read data from the stream.

Parameters

integer $length

Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Throws

\RuntimeException

if an error occurs.

Returns

string —

Returns the data read from the stream, or an empty string if no bytes are available.

getMetadata()

getMetadata(string  $key = null) : array|mixed|null

Get stream metadata as an associative array or retrieve a specific key.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

Parameters

string $key

Specific metadata to retrieve.

Returns

array|mixed|null —

Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.

serializeData()

serializeData(array<mixed,\Pydio\Core\Http\Response\SerializableResponseChunk>  $data, string  $serializer) : string

Parameters

array<mixed,\Pydio\Core\Http\Response\SerializableResponseChunk> $data
string $serializer

Throws

\RuntimeException

Returns

string