Class: Filter

Source Location: /filter/Filter.class.php

Class Overview

ParameterHolder
   |
   --Filter

Filter provides a way for you to intercept incoming requests or outgoing responses.

Author(s):

Sean Kerr (skerr@mojavi.org)

Version:

$Id: Filter.class.php 569 2004-12-05 06:25:47Z seank $

Copyright:

Methods

Child classes:

ExecutionTimeFilter: ExecutionTimeFilter tracks the length of time it takes for an entire request to be served starting with the dispatch and ending when the last action request has been served.

ExecutionFilter: ExecutionFilter is the last filter registered for each filter chain. This filter does all action and view execution.

SecurityFilter: SecurityFilter provides a base class that classifies a filter as one that handles security.

Inherited Variables

Class: ParameterHolder

ParameterHolder::$parameters

Inherited Methods

Class: ParameterHolder

ParameterHolder::clearParameters(): Clear all parameters associated with this request.
ParameterHolder::getParameter(): Retrieve a parameter.
ParameterHolder::getParameterNames(): Retrieve an array of parameter names.
ParameterHolder::getParameters(): Retrieve an array of parameters.
ParameterHolder::hasParameter(): Indicates whether or not a parameter exists.
ParameterHolder::removeParameter(): Remove a parameter.
ParameterHolder::setParameter(): Set a parameter.
ParameterHolder::setParameterByRef(): Set a parameter by reference.
ParameterHolder::setParameters(): Set an array of parameters.
ParameterHolder::setParametersByRef(): Set an array of parameters by reference.

Class Details

[line 24]
Filter provides a way for you to intercept incoming requests or outgoing responses.

Tags:

abstract:
version:	$Id: Filter.class.php 569 2004-12-05 06:25:47Z seank $
since:	1.0.0
copyright:	(c) Sean Kerr, http://www.mojavi.org
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

Class Methods

method execute [line 48]

void execute(
FilterChain
$filterChain)

Execute this filter.

Tags:

abstract:
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overridden in child classes as:

ExecutionTimeFilter::execute(): Execute this filter.

ExecutionFilter::execute(): Execute this filter.

BasicSecurityFilter::execute(): Execute this filter.

Parameters:

FilterChain

$filterChain

A FilterChain instance.

[ Top ]

method getContext [line 60]

Context getContext(
)

Retrieve the current application context.

Tags:

return:	The current Context instance.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

method initialize [line 84]

bool initialize(
Context
$context, [array
$parameters = null])

Initialize this Filter.

Tags:

return:	true, if initialization completes successfully, otherwise false.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	InitializationException If an error occurs while initializing this Filter.

Overridden in child classes as:

ExecutionTimeFilter::initialize(): Initialize this filter.

Parameters:

Context	$context	The current application context.
array	$parameters	An associative array of initialization parameters.

[ Top ]

Documentation generated on Tue, 21 Feb 2006 01:45:17 +0900 by phpDocumentor 1.3.0RC5