php_user_filter::filter

(PHP 5, PHP 7)

php_user_filter::filter — Called when applying the filter

说明

public php_user_filter::filter ( resource $in , resource $out , int &$consumed , bool $closing ) : int

This method is called whenever data is read from or written to the attached stream (such as with fread() or fwrite()).

参数

in

in is a resource pointing to a bucket brigade which contains one or more bucket objects containing data to be filtered.

out

out is a resource pointing to a second bucket brigade into which your modified buckets should be placed.

consumed

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.

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.

返回值

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.

相关文章
php streams the php user filter classphp map updates all values by applying a callback function to each valuephp evloop must be called after a forkphp filter 范例php ibm db2 函数 gets a user defined size of lob files with each invocationphp firebird/interbase 函数 register a callback function to be called when events are postedphp newt 函数 set a callback function which gets invoked when user presses the suspend keyphp oci8 函数 unregister a user defined callback function for oracle database tafphp posix 函数 return the effective user id of the current processphp stream 函数 register a user defined stream filterphp sybase 函数 sets the handler called when a server message is raisedphp vpopmail 函数 add a new user to the specified virtual domainphp wincache 函数 deletes entire content of the user cachephp xdiff 函数 read a size of file created by applying a binary diffphp gearmanclient set a callback for when a task is queuedphp harudoc define which page is shown when the document is openedphp imagickdraw sets the font family to use when annotating with textphp php user filter called when applying the filterphp php user filter called when closing the filterphp php user filter called when creating the filter
关注编程学问公众号