CFilter

Method Details

filter() method

public void filter(CFilterChain $filterChain)

public function filter($filterChain)
{
    if($this->preFilter($filterChain))
    {
        $filterChain->run();
        $this->postFilter($filterChain);
    }
}

Performs the filtering. The default implementation is to invoke preFilter and postFilter which are meant to be overridden child classes. If a child class needs to override this method, make sure it calls $filterChain->run() if the action should be executed.

init() method (available since v1.1.4)

public void init()

public function init()
{
}

Initializes the filter. This method is invoked after the filter properties are initialized and before preFilter is called. You may override this method to include some initialization logic.

postFilter() method

protected void postFilter(CFilterChain $filterChain)

protected function postFilter($filterChain)
{
}

Performs the post-action filtering.

preFilter() method

protected boolean preFilter(CFilterChain $filterChain)

protected function preFilter($filterChain)
{
    return true;
}

Performs the pre-action filtering.