Docs For Class GenericCategoryCache

Class Overview

GenericCategoryCache class

Located in /blogs/inc/MODEL/generic/_genericcategorycache.class.php [line 44]

DataObjectCache
   |
   --GenericCache
      |
      --GenericCategoryCache

Author(s):

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties	Inherited Methods	Inherited Constants
Inherited From DataObjectCache DataObjectCache::$all_loaded DataObjectCache::$cache DataObjectCache::$dbIDname DataObjectCache::$dbprefix DataObjectCache::$dbtablename DataObjectCache::$load_add DataObjectCache::$name_field DataObjectCache::$objtype DataObjectCache::$order_by DataObjectCache::$shadow_cache	Inherited From GenericCache GenericCache::GenericCache() Constructor GenericCache::new_obj() Instanciate a new object within this 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_ID_array() Get an array of all (loaded) IDs. 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() TODO DataObjectCache::option_list() Display form option list with cache contents DataObjectCache::option_list_return() Returns form option list with cache contents DataObjectCache::remove_by_ID() Remove an object from cache by ID

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObjectCache

DataObjectCache::$all_loaded

DataObjectCache::$cache

DataObjectCache::$dbIDname

DataObjectCache::$dbprefix

DataObjectCache::$dbtablename

DataObjectCache::$load_add

DataObjectCache::$name_field

DataObjectCache::$objtype

DataObjectCache::$order_by

DataObjectCache::$shadow_cache

Inherited From GenericCache

GenericCache::GenericCache()

Constructor

GenericCache::new_obj()

Instanciate a new object within this 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_ID_array()

Get an array of all (loaded) IDs.

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()

TODO

DataObjectCache::option_list()

Display form option list with cache contents

DataObjectCache::option_list_return()

Returns form option list with cache contents

DataObjectCache::remove_by_ID()

Remove an object from cache by ID

[ Top ]

Property Summary

mixed	$cats
mixed	$parent_cats
mixed	$revealed_children

[ Top ]

Method Summary

GenericCategoryCache	GenericCategoryCache()	Constructor
void	parent_option_list_return()	Returns form option list with cache contents
string	recurse()	Return recursive display of loaded categories
string	recurse_select()	Return recursive select options list of all loaded categories
void	Reveal_children()	Reveal_children

[ Top ]

Properties

mixed $cats = array() [line 47]

[ Top ]

mixed $parent_cats = array() [line 49]

[ Top ]

mixed $revealed_children = false [line 52]

[ Top ]

Methods

Constructor GenericCategoryCache [line 58]

GenericCategoryCache GenericCategoryCache(

$objtype, 
$load_all, 
$tablename, [
$prefix = ''], [
$dbIDname = 'ID'], [
$name_field = NULL] 
)

Constructor

Parameters:

	$objtype:
	$load_all:
	$tablename:
	$prefix:
	$dbIDname:
	$name_field:

[ Top ]

parent_option_list_return [line 200]

void parent_option_list_return(
[integer
$default = 0], [boolean
$allow_none = false], [
$method = 'name_return'] 
)

Returns 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 ''
	$method:

[ Top ]

recurse [line 109]

string recurse(
array
$callbacks, [array
$cat_array = NULL], [int
$level = 0] 
)

Return recursive display of loaded categories

Parameters:

array	$callbacks:	callback funtions (to format the display)
array	$cat_array:	categories list to display
int	$level:	depth of categories list

API Tags:

Return:

recursive list of all loaded categories

[ Top ]

recurse_select [line 155]

string recurse_select(
[integer
$selected = NULL], [array
$cat_array = NULL], [int
$level = 0] 
)

Return recursive select options list of all loaded categories

Parameters:

integer	$selected:	selected category in the select input
array	$cat_array:	categories list to display
int	$level:	depth of categories list

API Tags:

Return:

select options list of all loaded categories

[ Top ]

Reveal_children [line 67]

void Reveal_children(
)

Reveal_children

[ Top ]

Multilingual multiuser multiblog engine

Class: GenericCategoryCache

Class GenericCategoryCache

Packages

Classes

Files