Docs For Class AccessorAbstract

Class AccessorAbstract

Description

This is the abstract for user-defined Accessor methods. Accessors are used to

retrieve values from a cage object. By extending this abstract, developers can add their own accessor methods. Typically the only method they will need to define is AccessorAbstract::inspekt(), which takes a value, examines it, and returns a result. Array walking is automatically handled

author: Ed Finkler
abstract:

Located in /Inspekt/AccessorAbstract.php (line 12)

Variable Summary

string $cage

Method Summary

AccessorAbstract __construct (Inspekt_Cage $cage, [array $args = NULL])

mixed getValue (string $key)

void inspekt ( $val)

mixed run ([string $key = null])

void walkArray (mixed $input)

Variables

string $cage (line 19)

the cage object this is attached to, provided in the constructor

access: protected

Methods

Constructor __construct (line 28)

constructor

author: Ed Finkler
access: public

AccessorAbstract __construct (Inspekt_Cage $cage, [array $args = NULL])

Inspekt_Cage $cage
array $args: optional

getValue (line 64)

Retrieves a value from the cage

author: Ed Finkler
access: protected

mixed getValue (string $key)

string $key

inspekt (line 97)

abstract:
access: protected

void inspekt ( $val)

$val

run (line 41)

This executes the accessor on the key, either passed as the only argument, or the first value in $this->args;

author: Ed Finkler
access: public

mixed run ([string $key = null])

string $key

walkArray (line 76)

If an array is the value of the given key, this method walks the array recursively, applying $this->inspekt on any non-array values

author: Ed Finkler
access: protected

void walkArray (mixed $input)

mixed $input

Documentation generated on Fri, 15 Jan 2010 10:43:51 -0500 by phpDocumentor 1.4.3