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 при успішному.