b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (CVS HEAD) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Class: ItemTypeCache

Source Location: /blogs/inc/items/model/_itemtypecache.class.php

Class ItemTypeCache

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::$ID_array
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_list()
Get list of objects, referenced by list of 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::get_SQL_object()
Get base SQL object for queries.
DataObjectCache::instantiate()
Instantiate a DataObject from a table row and then cache it.
DataObjectCache::instantiate_list()
DataObjectCache::load_all()
Load the cache **extensively**
DataObjectCache::load_by_sql()
Load a set of objects into the cache.
DataObjectCache::load_list()
Load a list of objects into the cache.
DataObjectCache::load_where()
Load a set 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
DataObjectCache::rewind()
Rewind internal index to first position.

[ 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_usable_only()   Returns a form option list which only contains post types that can be used by the current user (and in the current blog's context).
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 48]

Item type cache for each collection


[ Top ]
mixed   $col_default = array() [line 53]

Default item type for each collection


[ Top ]
Methods
Constructor ItemTypeCache  [line 61]

  ItemTypeCache ItemTypeCache( table 0  )

Constructor

Parameters:
table   0:  Database row


[ Top ]
get_col_default_type_ID  [line 103]

  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 189]

  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 125]

  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_usable_only  [line 168]

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

Returns a form option list which only contains post types that can be used by the current user (and in the current blog's context).

The user cannot use any post type IDs listed in the {@see $posttypes_reserved_IDs} array; to use the "Page", "Intro-*", "Podcast" and "Sidebar link" post types, the current blog must grant the blog_page, blog_intro, blog_podcast and blog_sidebar permission, respectively (see blog user/group permissions).

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


[ Top ]
load_col  [line 73]

  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 ]

Documentation generated on Sat, 06 Mar 2010 04:16:38 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).