array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.stream-filter-append.php', 1 => 'stream_filter_append', 2 => 'Anexa um filtro a um fluxo', ), 'up' => array ( 0 => 'ref.stream.php', 1 => 'Funções de Fluxo', ), 'prev' => array ( 0 => 'function.stream-copy-to-stream.php', 1 => 'stream_copy_to_stream', ), 'next' => array ( 0 => 'function.stream-filter-prepend.php', 1 => 'stream_filter_prepend', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/stream/functions/stream-filter-append.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

stream_filter_append

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

stream_filter_append — Anexa um filtro a um fluxo

Descrição

stream_filter_append(
    resource $stream,
    string $filter_name,
    int $mode = ?,
    mixed $params = ?
): resource

Adiciona o nome do filtro filter_name à lista de filtros anexados ao fluxo stream.

Parâmetros

stream

O fluxo alvo.

filter_name

O nome do filtro.

mode

Por padrão, stream_filter_append() irá anexar o filtro à cadeia de filtros de leitura se o arquivo foi aberto para leitura (isto é, modo de arquivo: r e/ou +). O filtro também será anexado à cadeia de filtros de escrita se o arquivo foi aberto para escrita (isto é, modo de arquivo: w, a e/ou +). As constantes STREAM_FILTER_READ, STREAM_FILTER_WRITE e/ou STREAM_FILTER_ALL também podem ser passadas ao parâmetro mode para substituir este comportamento.

params

Este filtro será adicionado com os parâmetros especificados em params ao final da lista e portanto serão chamados por último durante operações de fluxo. Para adicionar um filtro ao início da lista, use stream_filter_prepend().

Valor Retornado

Retorna um recurso em caso de sucesso ou false em caso de falha. O recurso pode ser usado para se referir a este instância de filtro durante a chamada a stream_filter_remove().

false é retornado se o parâmetro stream não for um recurso ou se o nome do filtro filter_name não puder ser localizado.

Exemplos

Exemplo #1 Controlando onde os filtros são aplicados

<?php
/* Abre um arquivo de teste para leitura e escrita */
$fp = fopen('teste.txt', 'w+');

/* Applica o filtro ROT13 à
* cadeia de filtros de escrita, mas não à
* cadeia de filtros de leitura */
stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE);

/* Escreve uma string simples ao arquivo
* que será transformado através do ROT13 na
* saída */
fwrite($fp, "Teste de filtro\n");

/* Retrocede ao início do arquivo */
rewind($fp);

/* Lê de volta o conteúdo do arquivo.
* Se o filtro tivesse sido aplicado também
* à cadeia de filtros de leitura, seria visto o texto
* com o filtro ROT13 reaplicado, de volta a seu estado original */
fpassthru($fp);

fclose($fp);

/* Resultado esperado
---------------

Grfgr qr svygeb

*/
?>

Notas

Nota: Usando filtros personalizados (do usuário)
stream_filter_register() deve ser chamado em primeiro lugar de maneira a registrar o filtro de usuário desejado para o valor de filter_name.

Nota: Dados de fluxo são lidos dos recursos (tanto locais quanto remotos) em partes, com quaisquer dados não consumidos mantidos em buffers internos. Quando um novo filtro é anexado a um fluxo, dados no buffer interno são processados através do novo filtro neste momento. Isto difere do comportamento de stream_filter_prepend().

Nota: Quando um filtro é adicionado para leitura e escrita, duas instâncias do filtro são criadas. stream_filter_append() deve ser chamada duas vezes com STREAM_FILTER_READ e STREAM_FILTER_WRITE para obter ambos os recursos de filtro.

Veja Também