Docs For Class DataObjectCache

Class Overview

Data Object Cache Class

Located in /blogs/b2evocore/_class_dataobjectcache.php [line 21]

Author(s):

Information Tags:

Version:

beta

Methods

[ Top ]

Direct descendents

Child Class	Description
BlogCache	Blog Cache Class
ItemCache	Item Cache Class

[ Top ]

Method Summary

DataObjectCache	DataObjectCache()	Constructor
void	add()	Add a dataobject to the cache
void	clear()	Clear the cache extensively
void	get_by_ID()	Get an object from cache by ID
void	load_all()	Load the cache extensively
void	load_list()	Load a list of objects into the cache
void	option_list()	Display form option list with cache contents

[ Top ]

Methods

Constructor DataObjectCache [line 46]

DataObjectCache DataObjectCache(
string
$objtype, boolean
$load_all, string
$tablename, [string
$prefix = ''], [string
$dbIDname = 'ID'] 
)

Constructor

Parameters:

string	$objtype:	Name of DataObject class we are cacheing
boolean	$load_all:	true if it's OK to just load all items!
string	$tablename:	Name of table in database
string	$prefix:	Prefix of fields in the table
string	$dbIDname:	Name of the ID field (including prefix)

[ Top ]

add [line 116]

void add(

&$Obj 
)

Add a dataobject to the cache

Parameters:

&$Obj:

[ Top ]

clear [line 132]

void clear(
)

Clear the cache **extensively**

[ Top ]

get_by_ID [line 149]

void get_by_ID(
integer
$req_ID, [boolean
$halt_on_error = true] 
)

Get an object from cache by ID

Load the cache if necessary

Parameters:

integer	$req_ID:	ID of object to load
boolean	$halt_on_error:	false if you want to return false on error

[ Top ]

load_all [line 61]

void load_all(
)

Load the cache **extensively**

[ Top ]

load_list [line 93]

void load_list(
string
$req_list 
)

Load a list of objects into the cache

Parameters:

string

$req_list:

list of IDs of objects to load

[ Top ]

option_list [line 195]

void option_list(
[integer
$default = 0], [boolean
$allow_none = false] 
)

Display form option list with cache contents

Load the cache if necessary

Parameters:

integer	$default:	selected ID
boolean	$allow_none:	provide a choice for "none" with ID 0

[ Top ]

Multilingual multiuser multiblog engine

Class: DataObjectCache

Class DataObjectCache

Packages

Classes

Files