Class: ItemTypeCache

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

Class ItemTypeCache

Class Overview

ItemTypeCache Class

Located in /qp_inc/items/model/_itemtypecache.class.php [line 42]

DataObjectCache
   |
   --ItemTypeCache

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::$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	$col_cache	Item type cache for each collection
mixed	$col_default	Default item type for each collection

[ Top ]

Method Summary

ItemTypeCache	ItemTypeCache()	Constructor
void	get_col_default_type_ID()	Return the default item type ID for a given collection
void	get_option_array()	For use by Universal Item List widget
string	get_option_list_by_col_ID()	Returns form option list with cache contents restricted to a collection
string	get_option_list_unreserved_only()	Returns a form option list which only contains unreserved post types.
void	load_col()	Load a list of item types for a given collection and store them into the collection cache

[ Top ]

Properties

mixed $col_cache = array() [line 47]

Item type cache for each collection

[ Top ]

mixed $col_default = array() [line 52]

Default item type for each collection

[ Top ]

Methods

Constructor ItemTypeCache [line 60]

ItemTypeCache ItemTypeCache(
table
0 
)

Constructor

Parameters:

table

Database row

[ Top ]

get_col_default_type_ID [line 102]

void get_col_default_type_ID(
integer
$col_ID 
)

Return the default item type ID for a given collection

fp> will be used in b2evo 2.0

Parameters:

integer

$col_ID:

collection ID

[ Top ]

get_option_array [line 172]

void get_option_array(
)

For use by Universal Item List widget

Redefinition of:

DataObjectCache::get_option_array(): Returns option array with cache contents

[ Top ]

get_option_list_by_col_ID [line 124]

string get_option_list_by_col_ID(
integer
$default, integer
$col_ID 
)

Returns form option list with cache contents restricted to a collection

Load the item types collection cache if necessary

fp> will be used in b2evo 2.0

Parameters:

integer	$default:	selected ID
integer	$col_ID:	collection ID

[ Top ]

get_option_list_unreserved_only [line 162]

string get_option_list_unreserved_only(
[integer
$default = 0], [boolean
$allow_none = false], [string
$method = 'get_name'] 
)

Returns a form option list which only contains unreserved post types.

Parameters:

integer	$default:	The selected ID.
boolean	$allow_none:	Provide a choice for "none" with ID ''
string	$method:	Callback method name.

API Tags:

See:

$posttypes_reserved_IDs

[ Top ]

load_col [line 72]

void load_col(

$col_ID 
)

Load a list of item types for a given collection and store them into the collection cache

Note: object will also get stored into the global cache.

Parameters:

$col_ID:

[ Top ]

hic sunt dracones

	items

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