Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_data_file_Object
  • icms_data_urllink_Object
  • icms_ipf_Object
  • icms_ipf_registry_Handler
  • icms_ipf_seo_Object
  • Overview
  • Package
  • Class

Class icms_ipf_registry_Handler

Registry of icms_ipf_Object

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

Package: Ipf\Object
Category: ICMS
Copyright: The ImpressCMS Project http://www.impresscms.org/
License: GNU General Public License (GPL)
Author: marcan marcan@impresscms.org
Since: 1.1
Located at ipf/registry/Handler.php
Methods summary
public static object &
# getInstance( )

Access the only instance of this class

Access the only instance of this class

Returns

object
public false
# addObjectsFromHandler( icms_ipf_Handler & $handler, icms_db_criteria_Compo $criteria = false )

Adding objects to the registry

Adding objects to the registry

Parameters

$handler
of the objects to add
$criteria
to pass to the getObjects method of the handler (with id_as_key)

Returns

false
if an error occured
public false
# addListFromHandler( icms_ipf_Handler & $handler, icms_db_criteria_Compo $criteria = false )

Adding objects as list to the registry

Adding objects as list to the registry

Parameters

$handler
of the objects to add
$criteria
to pass to the getObjects method of the handler (with id_as_key)

Returns

false
if an error occured
public false
# addObjectsFromItemName( string $item, string $modulename = false, icms_db_criteria_Compo $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

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

Parameters

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

Returns

false
if an error occured
public false
# addListFromItemName( string $item, string $modulename = false, icms_db_criteria_Compo $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

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

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

Returns

false
if an error occured
public the
# getObjects( string $itemname, string $modulename )

Fetching objects from the registry

Fetching objects from the registry

Parameters

$itemname
$modulename

Returns

the
requested objects or FALSE if they don't exists in the registry
public the
# getList( string $itemname, string $modulename )

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

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

Parameters

$itemname
$modulename

Returns

the
requested objects or FALSE if they don't exists in the registry
public the
# getSingleObject( string $itemname, string $key, $modulename = false )

Retreive a single object

Retreive a single object

Parameters

$itemname
$key
$modulename

Returns

the
requestd object or FALSE if they don't exists in the registry
API documentation generated by ApiGen