Class: Filter

Source Location: /filter/Filter.class.php

Class Overview

Filter allows you to intercept a request and handle pre-action execution or control the result of an action after it has been executed.

Author(s):

Sean Kerr

Variables

$params

Methods

Child classes:

ExecutionFilter: ExecutionFilter is the main filter that does controls the validation, action execution and view rendering.

Inherited Variables

Inherited Methods

Class Details

[line 21]
Filter allows you to intercept a request and handle pre-action execution or control the result of an action after it has been executed.

Tags:

since:	1.0
author:	Sean Kerr

[ Top ]

Class Variables

$params =

[line 31]

An associative array of initialization parameters.

Tags:

since:	2.0
access:	protected

Type:

mixed

[ Top ]

Class Methods

constructor Filter [line 39]

Filter &Filter(
)

Create a new Filter instance.

Tags:

since:	1.0
access:	public

[ Top ]

method execute [line 60]

void execute(
FilterChain
&$filterChain, Controller
&$controller, Request
&$request, User
&$user)

Execute the filter.

<note> This method should never be called manually. </note>

Overridden in child classes as:

ExecutionFilter::execute(): Execute this filter.

Parameters:

FilterChain	&$filterChain	A FilterChain instance.
Controller	&$controller	A Controller instance.
Request	&$request	A Request instance.
User	&$user	A User instance.

[ Top ]

method initialize [line 80]

void initialize(
array
$params)

Initialize the filter.

Tags:

since:	1.0
access:	public

Parameters:

array

$params

An associative array of initialization parameters.

[ Top ]

Documentation generated on Wed, 15 Jun 2005 11:43:28 +0900 by phpDocumentor 1.2.3