C# Класс Pchp.Library.Streams.PhpFilter

Base class for PHP stream filters.
Наследование: IFilter
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
parameters object

Private Properties

Свойство Тип Описание
GetFilter bool
MergeFilterNames Pchp.Core.PhpArray

Открытые методы

Метод Описание
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.

Приватные методы

Метод Описание
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).

Описание методов

AddSystemFilter() публичный статический Метод

Register a built-in stream filter factory.
public static AddSystemFilter ( IFilterFactory factory ) : bool
factory IFilterFactory The filter factory.
Результат bool

AddUserFilter() публичный статический Метод

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.
Результат bool

Filter() публичный абстрактный Метод

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
Результат TextElement

GetFilterNames() публичный статический Метод

Retrieves the list of registered filters.
public static GetFilterNames ( ) : PhpArray
Результат Pchp.Core.PhpArray

OnClose() публичный Метод

Called when the containig stream is being closed.
public OnClose ( ) : void
Результат void

OnCreate() публичный Метод

Called when the filter is attached to a stream.
public OnCreate ( ) : void
Результат void

PhpFilter() публичный Метод

Creates a new instance of the PhpFilter.
public PhpFilter ( object parameters ) : System
parameters object The parameters.
Результат System

Описание свойств

parameters защищенное свойство

An additional mixed parameter passed at stream_filter_append/prepend.
protected object parameters
Результат object