Class: IcmsPersistableRegistry

Source Location: /kernel/icmspersistableregistry.php

Class IcmsPersistableRegistry

Class Overview

Registry of IcmsPersistableObject

Class responsible of caching objects to make them easily reusable without querying the database

Located in /kernel/icmspersistableregistry.php [line 17]



		
				Author(s):
		
		
		
API Tags:
Filesource:  Source Code for this file

Information Tags:
Version:  $Id: icmspersistabletable.php 1948 2008-05-01 19:01:10Z malanciault $
Copyright:  The ImpressCMS Project http://www.impresscms.org/
Since:  1.1
License:  GNU General Public License (GPL)

Properties

Methods

[ Top ]
Property Summary
mixed   $_registryArray  

[ Top ]
Method Summary
static object   &getInstance()   Access the only instance of this class
FALSE   addListFromHandler()   Adding objects as list to the registry
FALSE   addListFromItemName()   Adding objects as a list to the registry from an item name This method will fetch the handler of the item / module and call the addListFromHandler
FALSE   addObjectsFromHandler()   Adding objects to the registry
FALSE   addObjectsFromItemName()   Adding objects to the registry from an item name This method will fetch the handler of the item / module and call the addObjectsFromHandler
the   getList()   Fetching objects from the registry, as a list : objectid => identifier
the   getObjects()   Fetching objects from the registry
the   getSingleObject()   Retreive a single object

[ Top ]
Properties
mixed   $_registryArray [line 19]

[ Top ]
Methods
static method getInstance  [line 29]

  static object &getInstance( )

Access the only instance of this class


API Tags:
Staticvar:  object $instance:


[ Top ]
addListFromHandler  [line 64]

  FALSE addListFromHandler( &$handler, [CriteriaCompo $criteria = false], IcmsPersistableObjectHandler $handler  )

Adding objects as list to the registry

Parameters:
IcmsPersistableObjectHandler   $handler:  of the objects to add
CriteriaCompo   $criteria:  to pass to the getObjects method of the handler (with id_as_key)
   &$handler: 

API Tags:
Return:  if an error occured


[ Top ]
addListFromItemName  [line 107]

  FALSE addListFromItemName( string $item, [string $modulename = false], [CriteriaCompo $criteria = false]  )

Adding objects as a list to the registry from an item name This method will fetch the handler of the item / module and call the addListFromHandler

Parameters:
string   $item:  name of the item
string   $modulename:  name of the module
CriteriaCompo   $criteria:  to pass to the getObjects method of the handler (with id_as_key)

API Tags:
Return:  if an error occured


[ Top ]
addObjectsFromHandler  [line 46]

  FALSE addObjectsFromHandler( &$handler, [CriteriaCompo $criteria = false], IcmsPersistableObjectHandler $handler  )

Adding objects to the registry

Parameters:
IcmsPersistableObjectHandler   $handler:  of the objects to add
CriteriaCompo   $criteria:  to pass to the getObjects method of the handler (with id_as_key)
   &$handler: 

API Tags:
Return:  if an error occured


[ Top ]
addObjectsFromItemName  [line 84]

  FALSE addObjectsFromItemName( string $item, [string $modulename = false], [CriteriaCompo $criteria = false]  )

Adding objects to the registry from an item name This method will fetch the handler of the item / module and call the addObjectsFromHandler

Parameters:
string   $item:  name of the item
string   $modulename:  name of the module
CriteriaCompo   $criteria:  to pass to the getObjects method of the handler (with id_as_key)

API Tags:
Return:  if an error occured


[ Top ]
getList  [line 159]

  the getList( string $itemname, string $modulename  )

Fetching objects from the registry, as a list : objectid => identifier

Parameters:
string   $itemname: 
string   $modulename: 

API Tags:
Return:  requested objects or FALSE if they don't exists in the registry


[ Top ]
getObjects  [line 129]

  the getObjects( string $itemname, string $modulename  )

Fetching objects from the registry

Parameters:
string   $itemname: 
string   $modulename: 

API Tags:
Return:  requested objects or FALSE if they don't exists in the registry


[ Top ]
getSingleObject  [line 189]

  the getSingleObject( string $itemname, string $key, [ $modulename = false]  )

Retreive a single object

Parameters:
string   $itemname: 
string   $key: 
   $modulename: 

API Tags:
Return:  requestd object or FALSE if they don't exists in the registry


[ Top ]

Documentation generated on Sat, 15 Nov 2008 14:17:53 -0600 by phpDocumentor 1.4.1