HomeMenu
Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

stream_filter_prepend

Description

The stream_filter_prepend of Stream for PHP attach a filter to a stream.

Syntax

stream_filter_prepend ( resource $stream , string $filtername [, int $read_write [, mixed $params ]] ) : resource

Parameters

stream

The target stream.

filtername

The filter name.

read_write

By default, stream_filter_prepend() 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() for an example of using this parameter.

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().

Return

Returns a resource on success or FALSE on failure. The resource can be used to refer to this filter instance during a call to stream_filter_remove(). FALSE is returned if stream is not a resource or if filtername cannot be located.

Examples

1 · stream filtername

<?

$filename = "stream_filter_prepend.txt";
$mode = "w+";

$handle = fopen($filename, $mode);

    $filtername = "string.rot13";

    stream_filter_prepend($handle, $filtername);

    fwrite($handle, "Hello");
    rewind($handle);
    fpassthru($handle);

fclose($handle);

Hello

2 · read_write

<?

$filename = "stream_filter_prepend.txt";
$mode = "w+";

$handle = fopen($filename, $mode);

    $filtername = "string.rot13";
    $read_write = STREAM_FILTER_WRITE;

    stream_filter_prepend($handle, $filtername, $read_write);

    fwrite($handle, "Hello");
    rewind($handle);
    fpassthru($handle);

fclose($handle);

Uryyb

3 · params

<?

$filename = "stream_filter_prepend.txt";
$mode = "w+";

$handle = fopen($filename, $mode);

    $filtername = "string.rot13";
    $read_write = STREAM_FILTER_WRITE;
    $params = array("a" => 0, "b" => 1);

    stream_filter_prepend($handle, $filtername, $read_write, $params);

    fwrite($handle, "Hello");
    rewind($handle);
    fpassthru($handle);

fclose($handle);

Uryyb

4 · Return

<?

$filename = "stream_filter_prepend.txt";
$mode = "w+";

$handle = fopen($filename, $mode);

    $filtername = "string.rot13";

    $return = stream_filter_prepend($handle, $filtername);

    echo $return;

fclose($handle);

Resource id #4