php_user_filter::onCreate

(PHP 5, PHP 7, PHP 8)

php_user_filter::onCreate — Appelé lors de la création du filtre

Description

public php_user_filter::onCreate(): bool

Cette méthode est appelée lors de l'instanciation de l'objet de la classe de filtrage. Si le filtre alloue ou initialise d'autres ressources (comme un buffer), c'est la place pour le faire.

Lorsque le filtre est instancié et que yourfilter->onCreate() est appelé, un nombre de propriétés sera disponible comme montré dans la table ci-dessous.

Propriétés Contenus

FilterClass->filtername Une chaîne contenant le nom utilisé pour instancier le filtre. Les filtres peuvent être enregistrés sous plusieurs noms ou avec des jokers. Utiliser cette propriété pour déterminer quel est le nom qui a été utilisé.

FilterClass->params Le contenu du paramètre params passé à la fonction stream_filter_append() ou la fonction stream_filter_prepend().

FilterClass->stream La ressource du flux à filtrer. Ne peut être disponible que lors de l'appel à la méthode filter() lorsque le paramètre closing est défini à false.

Propriétés	Contenus
`FilterClass->filtername`	Une chaîne contenant le nom utilisé pour instancier le filtre. Les filtres peuvent être enregistrés sous plusieurs noms ou avec des jokers. Utiliser cette propriété pour déterminer quel est le nom qui a été utilisé.
`FilterClass->params`	Le contenu du paramètre `params` passé à la fonction stream_filter_append() ou la fonction stream_filter_prepend().
`FilterClass->stream`	La ressource du flux à filtrer. Ne peut être disponible que lors de l'appel à la méthode filter() lorsque le paramètre `closing` est défini à `false`.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

L'implémentation de cette méthode doit retourner false si une erreur survient, ou true en cas de succès.