Koowa_Filter
[ class tree: Koowa_Filter ] [ index: Koowa_Filter ] [ all elements ]

Class: KFilterChain

Source Location: /libraries/koowa/filter/chain.php

Class Overview

KObject
   |
   --KObjectQueue
      |
      --KCommandChain
         |
         --KFilterChain

Filter Chain


Author(s):

Methods


Inherited Variables

Inherited Methods

Class: KCommandChain

KCommandChain::__construct()
Constructor
KCommandChain::contains()
Check if the queue does contain a given object
KCommandChain::dequeue()
Removes a command from the queue
KCommandChain::disable()
Disable the chain
KCommandChain::enable()
Enable the chain
KCommandChain::enqueue()
Attach a command to the chain
KCommandChain::getContext()
Factory method for a command context.
KCommandChain::getPriority()
Get the priority of a command
KCommandChain::getStack()
Get the chain object stack
KCommandChain::run()
Run the commands in the chain
KCommandChain::setPriority()
Set the priority of a command
KCommandChain::_initialize()
Initializes the options for the object

Class: KObjectQueue

KObjectQueue::__construct()
Constructor
KObjectQueue::contains()
Check if the queue does contain a given object
KObjectQueue::count()
Returns the number of elements in the queue
KObjectQueue::current()
Return current object pointed by the iterator
KObjectQueue::dequeue()
Removes an object from the queue
KObjectQueue::enqueue()
Inserts an object to the queue.
KObjectQueue::getPriority()
Get the priority of an object in the queue
KObjectQueue::hasPriority()
Check if the queue has an item with the given priority
KObjectQueue::isEmpty()
Checks whether the queue is empty
KObjectQueue::key()
Return current object index
KObjectQueue::next()
Move to the next object
KObjectQueue::rewind()
Rewind the Iterator to the top
KObjectQueue::setPriority()
Set the priority of an object in the queue
KObjectQueue::top()
Return the object from the top of the queue
KObjectQueue::valid()
Check whether the queue contains more object
KObjectQueue::__clone()
Preform a deep clone of the object

Class: KObject

KObject::__construct()
Constructor
KObject::get()
Get the object properties
KObject::getHandle()
Get a handle for this object
KObject::getIdentifier()
Gets the service identifier.
KObject::getMethods()
Get a list of all the available methods
KObject::getService()
Get an instance of a class based on a class identifier only creating it if it does not exist yet.
KObject::inherits()
Checks if the object or one of it's mixin's inherits from a class.
KObject::mixin()
Mixin an object
KObject::set()
Set the object properties
KObject::_initialize()
Initializes the options for the object
KObject::__call()
Search the mixin method map and call the method or trigger an error
KObject::__clone()
Preform a deep clone of the object.

Class Details

[line 19]
Filter Chain

The filter chain overrides the run method to implement a seperate validate and santize method




Tags:

author:  Johan Janssens <johan@nooku.org>


[ Top ]


Class Methods


method run [line 28]

mixed run( string $name, $context)

Run the commands in the chain



Tags:

access:  public


Overrides KCommandChain::run() (Run the commands in the chain)

Parameters:

string   $name   The filter name
array   $context   The data to be filtered

[ Top ]

method _sanitize [line 59]

mixed _sanitize( $context)

Sanitize the data



Tags:

access:  protected


Parameters:

scalar   $context   Valuae to be sanitized

[ Top ]

method _validate [line 41]

bool _validate( $context)

Validate the data



Tags:

return:  True when the data is valid
access:  protected


Parameters:

scalar   $context   Value to be validated

[ Top ]


Documentation generated on Sat, 18 May 2013 03:03:08 +0200 by phpDocumentor 1.4.3