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

Class: TemplateCache

Source Location: /qp_inc/templates/model/_templatecache.class.php

Class TemplateCache

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
array   $cache_by_folder   Cache by folder
mixed   $loaded_types  

[ Top ]
Method Summary
TemplateCache   TemplateCache()   Constructor
boolean   add()   Add object to cache, handling our own indices.
Template   &get_by_folder()   Get an object from cache by its folder name.
void   load_by_type()   Load the cache by type
void   &new_obj()   Instanciate a new object within this cache

[ Top ]
Properties
array   $cache_by_folder = array() [line 46]

Cache by folder


[ Top ]
mixed   $loaded_types = array() [line 48]

[ Top ]
Methods
Constructor TemplateCache  [line 54]

  TemplateCache TemplateCache( )

Constructor



[ Top ]
add  [line 67]

  boolean add( Template &$Template  )

Add object to cache, handling our own indices.

Parameters:
Template   &$Template: 

API Tags:
Return:  True on add, false if already existing.


Redefinition of:
DataObjectCache::add()
Add a dataobject to the cache

[ Top ]
get_by_folder  [line 86]

  Template &get_by_folder( string $req_folder, [boolean $halt_on_error = true]  )

Get an object from cache by its folder name.

Load the object into cache, if necessary.

This is used to get a template for an RSS/Aom type; also to check if a template is installed.

Parameters:
string   $req_folder:  folder name of object to load
boolean   $halt_on_error:  false if you want to return false on error

API Tags:
Return:  A Template object on success, false on failure (may also halt!)


[ Top ]
load_by_type  [line 122]

  void load_by_type( string $type  )

Load the cache by type

Parameters:
string   $type: 


[ Top ]
new_obj  [line 156]

  void &new_obj( [ $row = NULL], [ $template_folder = NULL]  )

Instanciate a new object within this cache

Parameters:
   $row: 
   $template_folder: 


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

[ Top ]