Class: ItemCache

Source Location: /qp_inc/items/model/_itemcache.class.php

Class ItemCache

Class Overview

Item Cache Class

Located in /qp_inc/items/model/_itemcache.class.php [line 44]

DataObjectCache
   |
   --ItemCache

Author(s):

Information Tags:

Version:

beta

Properties

$urltitle_index

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObjectCache

DataObjectCache::$all_loaded

DataObjectCache::$cache

DataObjectCache::$current_idx

DataObjectCache::$DataObject_array

DataObjectCache::$dbIDname

DataObjectCache::$dbprefix

DataObjectCache::$dbtablename

DataObjectCache::$load_all

DataObjectCache::$name_field

DataObjectCache::$none_option_text

DataObjectCache::$none_option_value

DataObjectCache::$objtype

DataObjectCache::$order_by

DataObjectCache::$shadow_cache

Inherited From DataObjectCache

DataObjectCache::DataObjectCache()

Constructor

DataObjectCache::add()

Add a dataobject to the cache

DataObjectCache::clear()

Clear the cache **extensively**

DataObjectCache::dbdelete_by_ID()

Delete an object from DB by ID.

DataObjectCache::get_by_ID()

Get an object from cache by ID

DataObjectCache::get_by_name()

Get an object from cache by name

DataObjectCache::get_first()

This provides a simple interface for looping over the contents of the Cache.

DataObjectCache::get_ID_array()

Get an array of all (loaded) IDs.

DataObjectCache::get_next()

This provides a simple interface for looping over the contents of the Cache.

DataObjectCache::get_option_array()

Returns option array with cache contents

DataObjectCache::get_option_list()

Returns form option list with cache contents

DataObjectCache::instantiate()

Instantiate a DataObject from a table row and then cache it.

DataObjectCache::load_all()

Load the cache **extensively**

DataObjectCache::load_list()

Load a list of objects into the cache

DataObjectCache::new_obj()

Instanciate a new object within this cache

DataObjectCache::remove_by_ID()

Remove an object from cache by ID

[ Top ]

Property Summary

mixed

$urltitle_index

Lazy filled index of url titles

[ Top ]

Method Summary

ItemCache	ItemCache()	Constructor
void	&get_by_urltitle()	Get an object from cache by its urltitle
void	load_urltitle_array()	Load a list of item referenced by their urltitle into the cache

[ Top ]

Properties

mixed $urltitle_index = array() [line 49]

Lazy filled index of url titles

[ Top ]

Methods

Constructor ItemCache [line 59]

ItemCache ItemCache(
[string
$objType = 'Item'], [string
$dbtablename = 'T_items__item'], [string
$dbprefix = 'post_'], [string
$dbIDname = 'post_ID'] 
)

Constructor

Parameters:

string	$objType:	object type of elements in Cache
string	$dbtablename:	Name of the DB table
string	$dbprefix:	Prefix of fields in the table
string	$dbIDname:	Name of the ID field (including prefix)

[ Top ]

get_by_urltitle [line 72]

void &get_by_urltitle(
string
$req_urltitle, [boolean
$halt_on_error = true] 
)

Get an object from cache by its urltitle

Load into cache if necessary

Parameters:

string	$req_urltitle:	stub of object to load
boolean	$halt_on_error:	false if you want to return false on error

[ Top ]

load_urltitle_array [line 112]

void load_urltitle_array(
array
$req_array 
)

Load a list of item referenced by their urltitle into the cache

Parameters:

array

$req_array:

of urltitles of Items to load

[ Top ]

hic sunt dracones

	items

[ class tree: items ] [ index: items ] [ all elements ]