From 158a015e881963245f2197c2535e7fc2d476a766 Mon Sep 17 00:00:00 2001 From: TAKAGI Masahiro Date: Wed, 21 Mar 2012 20:54:22 +0000 Subject: [PATCH] Add svn:keywords and svn:eol-style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324434 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/stream/php_user_filter/filter.xml | 268 +++++++++--------- reference/stream/php_user_filter/onclose.xml | 120 ++++---- reference/stream/php_user_filter/oncreate.xml | 206 +++++++------- 3 files changed, 297 insertions(+), 297 deletions(-) diff --git a/reference/stream/php_user_filter/filter.xml b/reference/stream/php_user_filter/filter.xml index aa06f6f3d8..ac2d953463 100644 --- a/reference/stream/php_user_filter/filter.xml +++ b/reference/stream/php_user_filter/filter.xml @@ -1,134 +1,134 @@ - - - - - - php_user_filter::filter - Called when applying the filter - - - - &reftitle.description; - - public intphp_user_filter::filter - resourcein - resourceout - intconsumed - boolclosing - - - This method is called whenever data is read from or written to - the attached stream (such as with fread or fwrite). - - - - - - &reftitle.parameters; - - - 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;. - - - - - - - - &reftitle.returnvalues; - - 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_user_filter::filter + Called when applying the filter + + + + &reftitle.description; + + public intphp_user_filter::filter + resourcein + resourceout + intconsumed + boolclosing + + + This method is called whenever data is read from or written to + the attached stream (such as with fread or fwrite). + + + + + + &reftitle.parameters; + + + 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;. + + + + + + + + &reftitle.returnvalues; + + 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. + + + + + + + + + + + + diff --git a/reference/stream/php_user_filter/onclose.xml b/reference/stream/php_user_filter/onclose.xml index 767d43b586..a31804dc60 100644 --- a/reference/stream/php_user_filter/onclose.xml +++ b/reference/stream/php_user_filter/onclose.xml @@ -1,60 +1,60 @@ - - - - - - php_user_filter::onClose - Called when closing the filter - - - - &reftitle.description; - - public voidphp_user_filter::onClose - - - - This method is called upon filter shutdown (typically, this is also - during stream shutdown), and is executed after - the flush method is called. If any resources - were allocated or initialized during onCreate() - this would be the time to destroy or dispose of them. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return value is ignored. - - - - - - - + + + + + + php_user_filter::onClose + Called when closing the filter + + + + &reftitle.description; + + public voidphp_user_filter::onClose + + + + This method is called upon filter shutdown (typically, this is also + during stream shutdown), and is executed after + the flush method is called. If any resources + were allocated or initialized during onCreate() + this would be the time to destroy or dispose of them. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Return value is ignored. + + + + + + + diff --git a/reference/stream/php_user_filter/oncreate.xml b/reference/stream/php_user_filter/oncreate.xml index 375a9e377e..8e06f3088a 100644 --- a/reference/stream/php_user_filter/oncreate.xml +++ b/reference/stream/php_user_filter/oncreate.xml @@ -1,103 +1,103 @@ - - - - - - php_user_filter::onCreate - Called when creating the filter - - - - &reftitle.description; - - public boolphp_user_filter::onCreate - - - - This method is called during instantiation of the filter class - object. If your filter allocates or initializes any other resources - (such as a buffer), this is the place to do it. - - - - When your filter is first instantiated, and - yourfilter->onCreate() is called, a number of properties - will be available as shown in the table below. - - - - - - - Property - Contents - - - - - FilterClass->filtername - - A string containing the name the filter was instantiated with. - Filters may be registered under multiple names or under wildcards. - Use this property to determine which name was used. - - - - FilterClass->params - - The contents of the params parameter passed - to stream_filter_append - or stream_filter_prepend. - - - - FilterClass->stream - - The stream resource being filtered. Maybe available only during - filter calls when the - closing parameter is set to &false;. - - - - - - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Your implementation of - this method should return &false; on failure, or &true; on success. - - - - - - - + + + + + + php_user_filter::onCreate + Called when creating the filter + + + + &reftitle.description; + + public boolphp_user_filter::onCreate + + + + This method is called during instantiation of the filter class + object. If your filter allocates or initializes any other resources + (such as a buffer), this is the place to do it. + + + + When your filter is first instantiated, and + yourfilter->onCreate() is called, a number of properties + will be available as shown in the table below. + + + + + + + Property + Contents + + + + + FilterClass->filtername + + A string containing the name the filter was instantiated with. + Filters may be registered under multiple names or under wildcards. + Use this property to determine which name was used. + + + + FilterClass->params + + The contents of the params parameter passed + to stream_filter_append + or stream_filter_prepend. + + + + FilterClass->stream + + The stream resource being filtered. Maybe available only during + filter calls when the + closing parameter is set to &false;. + + + + + + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Your implementation of + this method should return &false; on failure, or &true; on success. + + + + + + +