interface TransformInterface
The interface implemented by stream transforms.
Methods
tuple<string,integer,mixed> |
transform(string $data, mixed $context, boolean $isEnd = false)
Transform the supplied data. |
Details
at line 40
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.