STREAM_FILTER_PREPEND(3) 1 STREAM_FILTER_PREPEND(3)stream_filter_prepend - Attach a filter to a streamSYNOPSIS
resource stream_filter_prepend (resource $stream, string $filtername, [int $read_write], [mixed $params])
DESCRIPTION
Adds $filtername to the list of filters attached to $stream.
PARAMETERS
o $stream
- The target stream.
o $filtername
- The filter name.
o $read_write
- By default, stream_filter_prepend(3) will attach the filter to the read filter chain if the file was opened for reading (i.e.
File Mode: r, and/or +). The filter will also be attached to the write filter chain if the file was opened for writing (i.e. File
Mode: w, a, and/or +). STREAM_FILTER_READ, STREAM_FILTER_WRITE, and/or STREAM_FILTER_ALL can also be passed to the $read_write
parameter to override this behavior. See stream_filter_append(3) for an example of using this parameter.
o $params
- This filter will be added with the specified $params to the beginning of the list and will therefore be called first during
stream operations. To add a filter to the end of the list, use stream_filter_append(3).
RETURN VALUES
Returns a resource which can be used to refer to this filter instance during a call to stream_filter_remove(3).
CHANGELOG
+--------+---------------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------------------------------+
| 5.1.0 | |
| | |
| | Prior to PHP 5.1.0, this function returns TRUE |
| | on success or FALSE on failure. |
| | |
+--------+---------------------------------------------------+
NOTES
Note
When using custom (user) filters
stream_filter_register(3) must be called first in order to register the desired user filter to $filtername.
Note
Stream data is read from resources (both local and remote) in chunks, with any unconsumed data kept in internal buffers. When a new
filter is prepended to a stream, data in the internal buffers, which has already been processed through other filters will not be
reprocessed through the new filter at that time. This differs from the behavior of stream_filter_append(3).
Note
When a filter is added for read and write, two instances of the filter are created. stream_filter_prepend(3) must be called twice
with STREAM_FILTER_READ and STREAM_FILTER_WRITE to get both filter resources.
SEE ALSO stream_filter_register(3), stream_filter_append(3).
PHP Documentation Group STREAM_FILTER_PREPEND(3)
Check Out this Related Man Page
FILTER_INPUT_ARRAY(3) 1 FILTER_INPUT_ARRAY(3)filter_input_array - Gets external variables and optionally filters themSYNOPSIS
mixed filter_input_array (int $type, [mixed $definition], [bool $add_empty = true])
DESCRIPTION
This function is useful for retrieving many values without repetitively calling filter_input(3).
PARAMETERS
o $type
- One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, or INPUT_ENV.
o $definition
- An array defining the arguments. A valid key is a string containing a variable name and a valid value is either a filter type,
or an array optionally specifying the filter, flags and options. If the value is an array, valid keys are filter which specifies
the filter type, flags which specifies any flags that apply to the filter, and options which specifies any options that apply to
the filter. See the example below for a better understanding. This parameter can be also an integer holding a filter constant.
Then all values in the input array are filtered by this filter.
o $add_empty
- Add missing keys as NULL to the return value.
RETURN VALUES
An array containing the values of the requested variables on success, or FALSE on failure. An array value will be FALSE if the filter
fails, or NULL if the variable is not set. Or if the flag FILTER_NULL_ON_FAILURE is used, it returns FALSE if the variable is not set and
NULL if the filter fails.
EXAMPLES
Example #1
A filter_input_array(3) example
<?php
error_reporting(E_ALL | E_STRICT);
/* data actually came from POST
$_POST = array(
'product_id' => 'libgd<script>',
'component' => '10',
'versions' => '2.0.33',
'testscalar' => array('2', '23', '10', '12'),
'testarray' => '2',
);
*/
$args = array(
'product_id' => FILTER_SANITIZE_ENCODED,
'component' => array('filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_REQUIRE_ARRAY,
'options' => array('min_range' => 1, 'max_range' => 10)
),
'versions' => FILTER_SANITIZE_ENCODED,
'doesnotexist' => FILTER_VALIDATE_INT,
'testscalar' => array(
'filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_REQUIRE_SCALAR,
),
'testarray' => array(
'filter' => FILTER_VALIDATE_INT,
'flags' => FILTER_REQUIRE_ARRAY,
)
);
$myinputs = filter_input_array(INPUT_POST, $args);
var_dump($myinputs);
echo "
";
?>
The above example will output:
array(6) {
["product_id"]=>
array(1) {
[0]=>
string(17) "libgd%3Cscript%3E"
}
["component"]=>
array(1) {
[0]=>
int(10)
}
["versions"]=>
array(1) {
[0]=>
string(6) "2.0.33"
}
["doesnotexist"]=>
NULL
["testscalar"]=>
bool(false)
["testarray"]=>
array(1) {
[0]=>
int(2)
}
}
CHANGELOG
+--------+------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+------------------------------+
| 5.4.0 | |
| | |
| | Added $add_empty parameter. |
| | |
+--------+------------------------------+
NOTES
Note
There is no REQUEST_TIME key in INPUT_SERVER array because it is inserted into the $_SERVER later.
SEE ALSO filter_input(3), filter_var_array(3), "Types of filters".
PHP Documentation Group FILTER_INPUT_ARRAY(3)