php_user_filter

class php_user_filter (View source)

Properties

int

filter(resource $in, resource $out, int $consumed, bool $closing)

No description

bool

onCreate()

No description

void

onClose()

No description

No description

resource	$in	is a resource pointing to a bucket brigadebucket objects containing data to be filtered.
resource	$out	is a resource pointing to a second bucket brigade into which your modified buckets should be placed.
int	$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 increment consumed by $bucket->datalen for each $bucket.
bool	$closing	If the stream is in the process of closing (and therefore this is the last pass through the filterchain), the closing parameter will be set to TRUE

int

The filter() method must return one of three values upon completion.

Return Value	Meaning
PSFS_PASS_ON	Filter processed successfully with data available in the out``` bucket brigade.
PSFS_FEED_ME	Filter processed successfully, however no data was available to return. More data is required from the stream or prior filter.
PSFS_ERR_FATAL (default)	The filter experienced an unrecoverable error and cannot continue.

No description

bool

No description

void