diff --git a/appendices/filters.xml b/appendices/filters.xml new file mode 100644 index 0000000000..1ad7d57d02 --- /dev/null +++ b/appendices/filters.xml @@ -0,0 +1,203 @@ + + + + List of Built-In Filters + + The following is a list of a few built-in stream filters for + use with stream_filter_append. + Your version of PHP may have more filters (or fewer) than those + listed here. + + + + It is worth noting a slight asymmetry between + stream_filter_append + and stream_filter_prepend. + Every PHP stream contains a small read buffer + where it stores blocks of data retrieved from the + filesystem or other resource in order to process data + in the most efficient manner. As soon as data is pulled + from the resource into the stream's internal buffer, it + is immediately processed through any attached filters whether + the PHP application is actually ready for the data or not. + If data is sitting in the read buffer when a filter is + appended, this data will be immediately + processed through that buffer making the fact that is was + sitting in the buffer seem transparent. However, if data is + sitting in the read buffer when a filter is + prepended, this data will NOT + be processed through that filter. It will instead wait until + the next block of data is retrieved from the resource. + + + + For a list of filters installed in your version of + PHP use stream_get_filters. + + +
+ String Filters + + + Each of these filters does precisely what their name implies and + correspond to the behavior of a built-in php string handling function. + For more information on a given filter, refer to the manual page for + the corresponding function. + + + + + + String Filters + + + + + Name + PHP Function equivalent + Since Version + Parameters + + + + + string.rot13 + + str_rot13 + + PHP 4.3.0 + None + + + string.toupper + + strtoupper + + PHP 5.0.0 + None + + + string.tolower + + strtolower + + PHP 5.0.0 + None + + + string.strip_tags + + strip_tags + + PHP 5.0.0 + + String containing allowable tags, similar to second parameter of strip_tags. + May also be an array containing list of tags (excluding <> symbols). + + + + +
+ +
+ +
+ Conversion Filters + + + Like the string.* filters, the convert.* filters perform actions + similar to their names. + For more information on a given filter, refer to the manual page for + the corresponding function. + + + + + + Convert Filters + + + + + Name + PHP Function equivalent + Since Version + Parameters + + + + + convert.base64-encode + + base64_encode + + PHP 5.0.0 + + If parameters are provided as an associative array, + convert.base64-encode will insert the value of + $parameters['line-break-chars'] every $parameters['line-length'] + characters of base64 output. This allow automatic formatting of encoded output + otherwise acheived using chunk_split. + + + + convert.base64-decode + + base64_decode + + PHP 5.0.0 + None + + + convert.quoted-printable-encode + + None. This is the counterpart to quoted-pritnable-decode. + + PHP 5.0.0 + + line-break-chars and line-length are supported + in the same manner as convert.base64-encode above. In addition, + binary and force-encode-first are supported as + boolean values which default to &false;. + + + + convert.quoted-printable-decode + + quoted_printable_decode + + PHP 5.0.0 + + If line-break-chars were specified during the encoding process, + they should be specified here again in order to be stripped out for a successful decode. + + + + +
+ + +
+ + + +