Public Member Functions
	__construct ($strGroup)

	add ($strIdentifier, array $arrData)

	delete ($strIdentifier)

	exists ($strIdentifier)

	get ($strIdentifier)

	getAll ()

	setValidator ($cloValidator)

Private Attributes
	$strGroup = null

Static Private Attributes
static	$arrDataObjects = array()

static	$arrValidatorList = array()

Detailed Description

The DataObjectPool is a class to manage the DataObjects for different types.

DataObjects are stored within groups. Every group has a validatator, with is applyed to every DataObject stored in the group. If no validatator is set, no validation will be done.

A DataObject is referenced by an identifier, which is uniqiue within a group.

when creating a DataObjectPool instance, the wanted group is set. All following operations are done at this group.

Definition at line 23 of file DataObjectPool.class.php.

Constructor & Destructor Documentation

DDDBL\DataObjectPool::__construct ( $strGroup )

Parameters

$strGroup - the group of DataObjects to operate on

Exceptions

UnexpectedParameterTypeException - if given group is not a string

create an instance of DataObjectPool and store the group to operate on

Definition at line 56 of file DataObjectPool.class.php.

                                          {
   
     if(!is_string($strGroup))
       throw new UnexpectedParameterTypeException('string', $strGroup);
     
     $this->strGroup = $strGroup;
     
     if(!array_key_exists($this->strGroup, self::$arrValidatorList))
       self::$arrValidatorList[$this->strGroup] = null;
     
     if(!array_key_exists($this->strGroup, self::$arrDataObjects))
       self::$arrDataObjects[$this->strGroup] = array();
 
   }

Member Function Documentation

DDDBL\DataObjectPool::add	(		$strIdentifier,
		array	$arrData
	)

Parameters

$strIdentifier	- the unique identifier of the DataObject
$arrData	- the data to store in the DataObject

See Also: DataObject:add()

Exceptions

UnexpectedParameterTypeException	- if identifier is not a string
\Exception	- if given identifier is not unique

Returns: (DataObject) - reference to the created DataObject-instance

create a new DataObject and store it in the pool. The given identifier is the key to retrieve the DataObject from the pool. The given data are stored within the DataObject.

After creation and storage of the DataObject, a reference to the object is returned

Definition at line 110 of file DataObjectPool.class.php.

                                                       {
   
     if(!is_string($strIdentifier))
       throw new UnexpectedParameterTypeException('string', $strIdentifier);
     
     if($this->exists($strIdentifier))
       throw new \Exception ("identifier already in use: $strIdentifier");
     
     $objDataObject = new DataObject(self::$arrValidatorList[$this->strGroup], $arrData);
     
     self::$arrDataObjects[$this->strGroup][$strIdentifier] = $objDataObject;
     
     return $objDataObject;
   
   }

DDDBL\DataObjectPool::delete ( $strIdentifier )

Parameters

$strIdentifier - the identifier of the object to delete

Exceptions

UnexpectedParameterTypeException	- if given identifier is not a string
\Exception	- if the given identifier is not known

delete the stored DataObject from the DataObjectPool

Definition at line 135 of file DataObjectPool.class.php.

                                          {
     
     if(!is_string($strIdentifier))
       throw new UnexpectedParameterTypeException('string', $strIdentifier);
     
     if(!$this->exists($strIdentifier))
       throw new \Exception ("DataObject not found, identifier unknown: $strIdentifier");
     
     unset(self::$arrDataObjects[$this->strGroup][$strIdentifier]);
   
   }

DDDBL\DataObjectPool::exists ( $strIdentifier )

Parameters

$strIdentifier - the identifier to check

Exceptions

UnexpectedParameterTypeException - if given identifier is not a string

Returns: (boolean) true, if the identifier exists; (boolean) false, if the identifier do not exists

Definition at line 156 of file DataObjectPool.class.php.

                                          {
   
     if(!is_string($strIdentifier))
       throw new UnexpectedParameterTypeException('string', $strIdentifier);
       
     if(!isset(self::$arrDataObjects[$this->strGroup][$strIdentifier]))
       return false;
     
     return true;
   
   }

DDDBL\DataObjectPool::get ( $strIdentifier )

Parameters

$strIdentifier - the identifier of the DataObject to retrieve

Exceptions

UnexpectedParameterTypeException	- if given identifier is not a string
\Exception	- if given identifier is unknown

Returns: (DataObject) - reference to the DataObject

returns a reference to the DataObject stored under the identifer

Definition at line 179 of file DataObjectPool.class.php.

                                       {
   
     if(!is_string($strIdentifier))
       throw new UnexpectedParameterTypeException('string', $strIdentifier);
     
     if(!$this->exists($strIdentifier))
       throw new \Exception ("DataObject not found, identifier unknown: $strIdentifier");
       
     return self::$arrDataObjects[$this->strGroup][$strIdentifier];
     
   }

DDDBL\DataObjectPool::getAll ( )

Returns: (array) - list of all DataObjects of the active group

returns an array of all stored DataObjects of the active group with the following structure:

array([identifier] => DataObject-reference, [identifier-n] => DataObject-reference-n, [..])

Definition at line 201 of file DataObjectPool.class.php.

                            {
   
     return self::$arrDataObjects[$this->strGroup];
   
   }

DDDBL\DataObjectPool::setValidator ( $cloValidator )

Parameters

$cloValidator - the validator to set for the group

Exceptions

UnexpectedParameterTypeException - if given validator is not a callable

set the validator for the active group. this validator is given to each newly created DataObject. if it is changed, the existing DataObjects are NOT revalidated.

Definition at line 82 of file DataObjectPool.class.php.

                                               {
   
     if(!is_callable($cloValidator))
       throw new UnexpectedParameterTypeException('string', $cloValidator);
     
     self::$arrValidatorList[$this->strGroup] = $cloValidator;
     
   }

Member Data Documentation

DDDBL\DataObjectPool::$arrDataObjects = array()

staticprivate

list of DataObjects. stored in the following structure: array([group][uniqueue-identifier] => DataObject-reference, [group-n][uniqueue-identifier-n] => DataObject-reference-n, [..])

Definition at line 45 of file DataObjectPool.class.php.

DDDBL\DataObjectPool::$arrValidatorList = array()

staticprivate

list of validators for each group. structure: array([group] => validator-callback, [group-n] => validator-callback-n, [..])

Definition at line 37 of file DataObjectPool.class.php.

DDDBL\DataObjectPool::$strGroup = null

private

the actual group to operate on

Definition at line 29 of file DataObjectPool.class.php.

The documentation for this class was generated from the following file:

inc/DataObjectPool.class.php

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation