stream_filter_append
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
stream_filter_append — Прикріпити фільтр до потоку
Опис
stream_filter_append( resource $stream, string $filtername, int $read_write = ?, mixed $params = ?): resource
Добавляетfiltername
до списку фільтрів, прикріплених до stream
Список параметрів
stream
Цільовий потік.
filtername
Назва фільтра.
read_write
По умолчанию**stream_filter_append()**будет прикреплять фильтр кланцюжку фільтрів читання
, якщо файл був відкритий для читання (тобто режим файлу: r
, и/или+
). Фільтр також буде прикріплений до ланцюжку фільтрів запису
, якщо файл був відкритий для запису (тобто режим файлу: w
a
, и/или+
). Константи STREAM_FILTER_READ
STREAM_FILTER_WRITE
и/илиSTREAM_FILTER_ALL
також можуть бути передані у параметрі read_write
, щоб перевизначити цю поведінку.
params
Цей фільтр буде додано із зазначеними params
ккінцю списку і, таким чином, буде викликано останнім у списку потокових операцій. Щоб додати фільтр до початку списку, використовуйте stream_filter_prepend()
Значення, що повертаються
Повертає ресурс у разі успішного виконання або false
при невдачі. Ресурс повинен бути використаний для посилання на цей екземпляр фільтра під час виклику stream_filter_remove()
Поверне false
, якщо stream
не є ресурсом або якщо filtername
не найден.
Приклади
Приклад #1 Контроль застосування фільтрів
Loading...
Примітки
Зауваження При використанні фільтрів користувача
Спочатку має бути викликана функція stream_filter_register() для того, щоб зареєструвати бажаний фільтр користувача на ім'яfiltername
Зауваження: Поточні дані читаються з ресурсів (як локальних, так і віддалених) по шматках, і будь-які незатребувані дані зберігаються у внутрішніх буферах. Коли новий фільтр додається в кінець потоку, дані у внутрішніх буферах обробляються через новий фільтр. Це відрізняється від поведінки функції stream_filter_prepend()
Зауваження: Коли фільтр додається для читання та запису, створюються два екземпляри фільтра. Функція stream_filter_append() повинна бути викликана двічі з
STREAM_FILTER_READ
іSTREAM_FILTER_WRITE
щоб отримати обидва ресурси фільтра.
Дивіться також
- stream_filter_register() - Реєструє потоковий фільтр, визначений користувачем
- stream_filter_prepend() - Прикріплює фільтр до потоку
- stream_get_filters() - Отримати список зареєстрованих фільтрів