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