php_user_filter::onCreate

(PHP 5, PHP 7, PHP 8)

php_user_filter::onCreate — Вызывается при создании объекта фильтра

Описание

public php_user_filter::onCreate(): bool

Этот метод вызывается при создании фильтра во время создания экземпляра класса. В этом методе можно выделять необходимые ресурсы и инициализировать объекты (например, различные буферы).

Когда фильтр сначала создаётся и вызывается метод yourfilter->onCreate(), будет доступен ряд следующих свойств, которые описаны в таблице.

Свойство	Содержание
`FilterClass->filtername`	Строка, содержащая имя фильтра, присвоенное ему при создании. Фильтры можно регистрировать под разными именами или спецсимволами. Это свойство можно использовать для определения, какое имя было использовано.
`FilterClass->params`	Содержимое аргумента `params` передаётся в функцию stream_filter_append() или stream_filter_prepend().
`FilterClass->stream`	Ресурс потока, который будет фильтроваться. Свойство доступно, только если метод filter() вызывается, когда параметр `closing` равен `false`.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

Ваша реализация метода должна возвращать false при неудачном завершении работы или true при успешном.

add a note

User Contributed Notes

There are no user contributed notes for this page.