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 Контроль применения фильтров

<?php

/* Открываем тестовый файл для чтения и записи */
$fp = fopen('test.txt', 'w+');

/* Прикрепляем фильтр ROT13 к
 * цепочке фильтров записи, но не к
 * цепочке фильтров чтения */
stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE);

/* Записываем простую строку в файл,
 * она будет преобразована через фильтр ROT13
 * на выходе */
fwrite($fp, "This is a test\n");

/* Отматываем позицию указателя в начало файла */
rewind($fp);

/* Прочитаем содержимое файла.
 * Если фильтр также был бы прикреплён к
 * цепочке фильтров чтения, мы бы увидели
 * преобразованный фильтром ROT13 текст в исходном состоянии */
fpassthru($fp);

fclose($fp);

/* Ожидаемый вывод
   ---------------

Guvf vf n grfg

 */

?>

Примечания

Замечание: Передача пользовательских фильтров
Сначала требуется вызвать функцию 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() - Получает список зарегистрированных фильтров

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 2 notes

down

Dan J ¶

8 years ago

Note that stream filters applied to STDOUT are not called when outputting via echo or print.

This is easily demonstrated with the standard ROT13 filter:
<?php
stream_filter_append( STDOUT, "string.rot13" );

print "Hello PHP\n";
// Prints "Hello PHP"

fprintf( STDOUT, "Hello PHP\n" );
// Prints "Uryyb CUC"
?>

If you want to filter STDOUT, you may have better luck with an output buffering callback added via ob_start:
http://php.net/manual/en/function.ob-start.php

At the time of this writing, there is an open PHP feature request to support echo and print for stream filters:
https://bugs.php.net/bug.php?id=30583

down

net_navard at yahoo dot com ¶

18 years ago

Hello firends

The difference betweem adding a stream filter first or last in the filte list in only the order they will be applied to streams.

For example, if you're reading data from a file, and a given filter is placed in first place with stream_filter_prepend()the data will be processed by that filter first.

This example reads out file data and the filter is applied at the beginning of the reading operation:

<?php
/* Open a test file for reading */
$fp = fopen("test.txt", "r");
/* Apply the ROT13 filter to the
 * read filter chain, but not the
 * write filter chain */
stream_filter_prepend($fp, "string.rot13",
STREAM_FILTER_READ);
// read file data
$contents=fread($fp,1024);
// file data is first filtered and stored in $contents
echo $contents;
fclose($fp);
?>

On the other hand, if stream_filter_append() is used, then the filter will be applied at the end of the data operation. The thing about this is only the order filters are applied to streams. Back to the example, it's not the same thing removing new lines from file data and then counting the number of characters, than performing the inverse process. In this case, the order that filters are applied to stream is important.

This example writes a test string to a file. The filter is applied at the end of the writing operation:

<?php
/* Open a test file for writing */
$fp = fopen("test.txt", "w+");
/* Apply the ROT13 filter to the
 * write filter chain, but not the
 * read filter chain */
stream_filter_append($fp, "string.rot13",
STREAM_FILTER_WRITE);
/* Write a simple string to the file
 * it will be ROT13 transformed at the end of the
stream operation
 * way out */
fwrite($fp, "This is a test\n"); // string data is
first written, then ROT13 tranformed and lastly
written to file
/* Back up to the beginning of the file */
rewind($fp);
$contents=fread($fp,512);
fclose($fp);
echo $contents;
?>

In the first case, data is transformed at the end of the writing operation, while in the second one, data is first filtered and then stored in $contents.

                          With Regards 
                              Hossein

＋Добавить