The php_user_filter class

Introduction

Children of this class are passed to stream_filter_register. Note that the __construct method is not called; instead, php_user_filter::onCreate should be used for initialization.

Class synopsis

php_user_filter

/* Properties */

public string $filtername = "";

public mixed $params = "";

public resourcenull $stream = null;

/* Methods */

public int filter(
    resource $in,
    resource $out,
    int &$consumed,
    bool $closing
)

public void onClose()

public bool onCreate()

Properties

filtername: Name of the filter registered by stream_filter_append.
params
stream

Table of Contents

php_user_filter::filter — Called when applying the filter
php_user_filter::onClose — Called when closing the filter
php_user_filter::onCreate — Called when creating the filter