php_user_filter::onCreate

(PHP 5, PHP 7, PHP 8)

php_user_filter::onCreateChamado na criação do filtro

Descrição

public php_user_filter::onCreate(): bool

Este método é chamado durante a instanciação do objeto da classe do filtro. Se o filtro aloca ou inicializa quaisquer outros recursos (como em um buffer), este é o local a se fazê-lo.

Quando o filtro é instanciado pela primeira vez, e filtro->onCreate() é chamado, um número de propriedades estará disponível como mostrado na tabela abaixo.

Propriedade Conteúdo
filtro->filtername Uma string contendo o nome com o qual o filtro foi instanciado. Filtros podem ser registrados sob múltiplos nomes ou com caracteres coringas. Use esta propriedade para deverminar que nome foi usado.
filtro->params O conteúdo de params parameter passado para stream_filter_append() ou stream_filter_prepend().
filtro->stream O recurso de fluxo sendo filtrado. Possivelmente disponível apenas durante chamadas a filter() quando o parâmetro closing estiver definido para false.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

A implementação deste método deve retornar false em caso de falha, ou true em caso de sucesso.