phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Class: ChapterCache

Source Location: /qp_inc/chapters/model/_chaptercache.class.php

Class ChapterCache

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GenericCategoryCache

GenericCategoryCache::$loaded_subsets
GenericCategoryCache::$revealed_all_children
GenericCategoryCache::$revealed_subsets
GenericCategoryCache::$root_cats
GenericCategoryCache::$subset_cache
GenericCategoryCache::$subset_property
GenericCategoryCache::$subset_root_cats

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 GenericCategoryCache

GenericCategoryCache::GenericCategoryCache()
Constructor
GenericCategoryCache::add()
Add a dataobject to the cache
GenericCategoryCache::check_path_to_root()
Support function for reveal_children()
GenericCategoryCache::clear()
Empty/reset the cache
GenericCategoryCache::recurse()
Return recursive display of loaded categories
GenericCategoryCache::recurse_select()
Return recursive select options list of all loaded categories
GenericCategoryCache::reveal_children()
Reveal children

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_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   $urlname_index   Lazy filled index of url titles

[ Top ]
Method Summary
ChapterCache   ChapterCache()   Constructor
void   clear()   Empty/reset the cache
Chapter   &get_by_ID()   Get an object from cache by ID
reference   &get_by_urlname()   Get an object from cache by urlname
void   load_subset()   Load a keyed subset of the cache
void   move_Chapter_subtree()   Move a chapter and its descendants to a different collection
void   &new_obj()   Instanciate a new object within this cache
void   recurse_move_subtree()   Support function for move_Chapter_subtree

[ Top ]
Properties
mixed   $urlname_index = array() [line 39]

Lazy filled index of url titles


[ Top ]
Methods
Constructor ChapterCache  [line 45]

  ChapterCache ChapterCache( )

Constructor



[ Top ]
clear  [line 65]

  void clear( )

Empty/reset the cache



Redefinition of:
GenericCategoryCache::clear()
Empty/reset the cache

[ Top ]
get_by_ID  [line 83]

  Chapter &get_by_ID( integer $req_ID, [boolean $halt_on_error = true], [boolean $halt_on_empty = true], [integer|NULL $subset_ID = NULL]  )

Get an object from cache by ID

Load the cache if necessary (all at once if allowed).

Parameters:
integer   $req_ID:  ID of object to load
boolean   $halt_on_error:  true if function should die on error
boolean   $halt_on_empty:  true if function should die on empty/null
integer|NULL   $subset_ID:  NULL for all subsets

API Tags:
Return:  Reference on cached object or false.


Redefinition of:
DataObjectCache::get_by_ID()
Get an object from cache by ID

[ Top ]
get_by_urlname  [line 156]

  reference &get_by_urlname( string $req_urlname, [boolean $halt_on_error = true]  )

Get an object from cache by urlname

Load the cache if necessary (all at once if allowed).

Parameters:
string   $req_urlname:  ID of object to load
boolean   $halt_on_error:  true if function should die on error

API Tags:
Return:  on cached object


[ Top ]
load_subset  [line 197]

  void load_subset( integer|NULL $subset_ID  )

Load a keyed subset of the cache

Parameters:
integer|NULL   $subset_ID:  NULL for all subsets


[ Top ]
move_Chapter_subtree  [line 241]

  void move_Chapter_subtree( integer $chapter_ID, integer $src_collection_ID, integer $dest_collection_ID  )

Move a chapter and its descendants to a different collection

Parameters:
integer   $chapter_ID: 
integer   $src_collection_ID: 
integer   $dest_collection_ID: 


[ Top ]
new_obj  [line 307]

  void &new_obj( [object|NULL $row = NULL], [integer|NULL $subset_ID = NULL]  )

Instanciate a new object within this cache

Parameters:
object|NULL   $row: 
integer|NULL   $subset_ID:  subset to use for new object


Redefinition of:
GenericCache::new_obj()
Instanciate a new object within this cache

[ Top ]
recurse_move_subtree  [line 289]

  void recurse_move_subtree( Chapter &$Chapter, array &$list_array  )

Support function for move_Chapter_subtree

Parameters:
Chapter   &$Chapter: 
array   &$list_array: 


[ Top ]