Skip to content

icms_ipf_registry_Handler

Jump to bottom
Raimondas Rimkevičius edited this page Mar 9, 2020 · 1 revision
Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_ipf_registry_Handler

Registry of icms_ipf_Object

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

  • Class name: icms_ipf_registry_Handler
  • Namespace:

Properties

$_registryArray

private \unknown_type $_registryArray
  • Visibility: private

Methods

getInstance

object icms_ipf_registry_Handler::getInstance()

Access the only instance of this class

  • Visibility: public
  • This method is static.

addObjectsFromHandler

bool icms_ipf_registry_Handler::addObjectsFromHandler(\icms_ipf_Handler handler, \icms_db_criteria_Compo criteria)

Adding objects to the registry

  • Visibility: public

Arguments

addListFromHandler

bool icms_ipf_registry_Handler::addListFromHandler(\icms_ipf_Handler handler, \icms_db_criteria_Compo criteria)

Adding objects as list to the registry

  • Visibility: public

Arguments

addObjectsFromItemName

bool icms_ipf_registry_Handler::addObjectsFromItemName(string item, string modulename, \icms_db_criteria_Compo criteria)

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

  • Visibility: public

Arguments

  • item string - <p>name of the item</p>
  • modulename string - <p>name of the module</p>
  • criteria icms_db_criteria_Compo - <p>to pass to the getObjects method of the handler (with id_as_key)</p>

addListFromItemName

bool icms_ipf_registry_Handler::addListFromItemName(string item, string modulename, \icms_db_criteria_Compo criteria)

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

  • Visibility: public

Arguments

  • item string - <p>name of the item</p>
  • modulename string - <p>name of the module</p>
  • criteria icms_db_criteria_Compo - <p>to pass to the getObjects method of the handler (with id_as_key)</p>

getObjects

\the icms_ipf_registry_Handler::getObjects(string itemname, string modulename)

Fetching objects from the registry

  • Visibility: public

Arguments

  • itemname string
  • modulename string

getList

\the icms_ipf_registry_Handler::getList(string itemname, string modulename)

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

  • Visibility: public

Arguments

  • itemname string
  • modulename string

getSingleObject

\the icms_ipf_registry_Handler::getSingleObject(string itemname, string key, mixed modulename)

Retreive a single object

  • Visibility: public

Arguments

  • itemname string
  • key string
  • modulename mixed
Clone this wiki locally