(PHP 5, PHP 7)
php_user_filter::filter — Called when applying the filter
in is a resource pointing to a bucket brigade
which contains one or more bucket objects containing data to be filtered.
out is a resource pointing to a second bucket brigade
into which your modified buckets should be placed.
consumed, which must always
be declared by reference, should be incremented by the length of the data
which your filter reads in and alters. In most cases this means you will
consumed by $bucket->datalen
for each $bucket.
If the stream is in the process of closing
(and therefore this is the last pass through the filterchain),
closing parameter will be set to
The filter() method must return one of three values upon completion.
Filter processed successfully with data available in the
||Filter processed successfully, however no data was available to return. More data is required from the stream or prior filter.|
||The filter experienced an unrecoverable error and cannot continue.|