Doctrine 1.2.4
Public Member Functions
Doctrine_Query_Filter_Chain Class Reference

Public Member Functions

 add (Doctrine_Query_Filter $filter)
 
 get ($key)
 
 postQuery (Doctrine_Query $query)
 
 preQuery (Doctrine_Query $query)
 
 set ($key, Doctrine_Query_Filter $listener)
 

Detailed Description

Definition at line 33 of file Chain.php.

Member Function Documentation

Doctrine_Query_Filter_Chain::add ( Doctrine_Query_Filter  $filter)

add

Parameters
Doctrine_Query_Filter$filter
Returns
void

Definition at line 46 of file Chain.php.

{
$this->_filters[] = $filter;
}
Doctrine_Query_Filter_Chain::get (   $key)

returns a Doctrine_Query_Filter on success and null on failure

Parameters
mixed$key
Returns
mixed

Definition at line 58 of file Chain.php.

{
if ( ! isset($this->_filters[$key])) {
throw new Doctrine_Query_Exception('Unknown filter ' . $key);
}
return $this->_filters[$key];
}
Doctrine_Query_Filter_Chain::postQuery ( Doctrine_Query  $query)

postQuery

Method for listening the postQuery method of Doctrine_Query and to hook into the query building procedure, doing any custom / specialized post query procedures (for example logging) that are neccessary.

Returns
void

Definition at line 103 of file Chain.php.

{
foreach ($this->_filters as $filter) {
$filter->postQuery($query);
}
}
Doctrine_Query_Filter_Chain::preQuery ( Doctrine_Query  $query)

preQuery

Method for listening the preQuery method of Doctrine_Query and hooking into the query building procedure, doing any custom / specialized query building procedures that are neccessary.

Returns
void

Definition at line 87 of file Chain.php.

{
foreach ($this->_filters as $filter) {
$filter->preQuery($query);
}
}
Doctrine_Query_Filter_Chain::set (   $key,
Doctrine_Query_Filter  $listener 
)

set

Parameters
mixed$key
Doctrine_Query_Filter$listener
Returns
void

Definition at line 73 of file Chain.php.

{
$this->_filters[$key] = $listener;
}
The documentation for this class was generated from the following file: