Data Structures
class	CallbackFilter

Functions
	append ($stream, $callback, $read_write=STREAM_FILTER_ALL)

	fun ($filter, $parameters=null)

	prepend ($stream, $callback, $read_write=STREAM_FILTER_ALL)

	register ()

	remove ($filter)

Function Documentation

◆ append()

Clue\StreamFilter\append	(	$stream,
		$callback,
		$read_write = `STREAM_FILTER_ALL`
	)

append a callback filter to the given stream

Parameters

resource	$stream
callable	$callback
int	$read_write

Returns: resource filter resource which can be used for remove()

Exceptions

Exception on error @uses stream_filter_append()

Definition at line 17 of file clue/stream-filter/src/functions.php.

Referenced by Clue\StreamFilter\fun().

◆ fun()

Clue\StreamFilter\fun	(	$filter,
		$parameters = `null`
	)

Creates filter fun (function) which uses the given built-in $filter

Some filters may accept or require additional filter parameters – most filters do not require filter parameters. If given, the optional $parameters argument will be passed to the underlying filter handler as-is. In particular, note how not passing this parameter at all differs from explicitly passing a null value (which many filters do not accept). Please refer to the individual filter definition for more details.

Parameters

string	$filter	built-in filter name. See stream_get_filters() or http://php.net/manual/en/filters.php
mixed	$parameters	(optional) parameters to pass to the built-in filter as-is