C# Class Pchp.Library.Streams.PhpFilter

Base class for PHP stream filters.

Inheritance: IFilter

Protected Properties

Property	Type	Description
parameters	object

Property	Type	Description
GetFilter	bool
MergeFilterNames	Pchp.Core.PhpArray

Method	Description
AddSystemFilter ( IFilterFactory factory ) : bool	Register a built-in stream filter factory.
AddUserFilter ( string filter, string classname ) : bool	Registers a user stream filter.
Filter ( Context ctx, TextElement input, bool closing ) : TextElement	Processes the input (either of type string or byte[]) data and returns the filtered data in one of the formats above or `null`.
GetFilterNames ( ) : PhpArray	Retrieves the list of registered filters.
OnClose ( ) : void	Called when the containig stream is being closed.
OnCreate ( ) : void	Called when the filter is attached to a stream.
PhpFilter ( object parameters ) : System	Creates a new instance of the PhpFilter.

Method	Description
GetFilter ( string filter, bool instantiate, PhpFilter &instance, object parameters ) : bool	Searches for a filter implementation in the known PhpFilter descendants.
MergeFilterNames ( ICollection filterList, PhpArray rv ) : PhpArray	Merges the individual string[] into one PhpArray (numeric keys).

public static AddSystemFilter ( IFilterFactory factory ) : bool
factory	IFilterFactory	The filter factory.
return	bool

Registers a user stream filter.

public static AddUserFilter ( string filter, string classname ) : bool
filter	string	The name of the filter (may contain wildcards).
classname	string	The PHP user class (derived from php_user_filter) implementing the filter.
return	bool

Processes the input (either of type string or byte[]) data and returns the filtered data in one of the formats above or null.

public abstract Filter ( Context ctx, TextElement input, bool closing ) : TextElement
ctx	Pchp.Core.Context
input	TextElement
closing	bool
return	TextElement

Retrieves the list of registered filters.

public static GetFilterNames ( ) : PhpArray
return	Pchp.Core.PhpArray

Called when the containig stream is being closed.

public OnClose ( ) : void
return	void

Called when the filter is attached to a stream.

public OnCreate ( ) : void
return	void

Creates a new instance of the PhpFilter.

public PhpFilter ( object parameters ) : System
parameters	object	The parameters.
return	System

An additional mixed parameter passed at stream_filter_append/prepend.

protected object parameters
return	object