Class: ExecutionTimeFilter

Source Location: /filter/ExecutionTimeFilter.class.php

Class Overview

ParameterHolder
   |
   --Filter
      |
      --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.

Author(s):

Sean Kerr (skerr@mojavi.org)

Version:

$Id: ExecutionTimeFilter.class.php 666 2004-12-15 04:35:08Z seank $

Copyright:

Methods

Inherited Variables

Class: ParameterHolder

ParameterHolder::$parameters

Inherited Methods

Class: Filter

Filter::execute(): Execute this filter.
Filter::getContext(): Retrieve the current application context.
Filter::initialize(): Initialize this Filter.

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 33]
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.

Optional parameters:

comment - [Yes] - Should we add an HTML comment to the end of each output with the execution time?
replace - [No] - If this exists, every occurance of the value in the client response will be replaced by the execution time.

Tags:

version:	$Id: ExecutionTimeFilter.class.php 666 2004-12-15 04:35:08Z 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 78]

void execute(
FilterChain
$filterChain)

Execute this filter.

Tags:

access:	public
since:	1.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	FilterException If an erro occurs during execution.

Overrides Filter::execute() (Execute this filter.)

Parameters:

FilterChain

$filterChain

The filter chain.

[ Top ]

method initialize [line 181]

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:	FilterException If an error occurs during initialization.

Overrides Filter::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:16 +0900 by phpDocumentor 1.3.0RC5