stream_filter_append

Attach a filter to a stream

Syntax

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

params

This filter will be added with the specified params to the end of the list and will therefore be called last during stream operations. To add a filter to the beginning of the list, use stream_filter_prepend().

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_append.txt";
$mode = "w+";

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

    $filtername = "string.rot13";

    stream_filter_append($handle, $filtername);

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

fclose($handle);

?>
Hello

2 · read_write

<?

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

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

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

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

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

fclose($handle);

?>
Uryyb

3 · params

<?

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

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

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

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

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

fclose($handle);

?>
Uryyb

4 · Return

<?

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

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

    $filtername = "string.rot13";

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

    echo $return;

fclose($handle);

?>
Resource id #4

stream_bucket_append

stream_bucket_make_writeable

stream_bucket_new

stream_bucket_prepend

stream_context_create

stream_context_get_default

stream_context_get_options

stream_context_get_params

stream_context_set_default

stream_context_set_option

stream_context_set_params

stream_copy_to_stream

stream_filter_prepend

stream_filter_register

stream_filter_remove

stream_get_contents

stream_get_filters

stream_get_line

stream_get_meta_data

stream_get_transports

stream_get_wrappers

stream_is_local

stream_isatty

stream_notification_callback

stream_register_wrapper

stream_resolve_include_path

stream_select

stream_set_blocking

stream_set_chunk_size

stream_set_read_buffer

stream_set_timeout

stream_set_write_buffer

stream_socket_accept

stream_socket_client

stream_socket_enable_crypto

stream_socket_get_name

stream_socket_pair

stream_socket_recvfrom

stream_socket_sendto

stream_socket_server

stream_socket_shutdown

stream_supports_lock

stream_wrapper_register

stream_wrapper_restore

stream_wrapper_unregister

PHP

Home Menu