Class: WidgetCache

Source Location: /qp_inc/widgets/model/_widgetcache.class.php

Class WidgetCache

Class Overview

Widget Cache Class

Located in /qp_inc/widgets/model/_widgetcache.class.php [line 38]

DataObjectCache
   |
   --WidgetCache

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

array	$cache_container_Widget_array	Cache by container
boolean	$load_enabled_only	Indicates whether to load enabled widgets only.

[ Top ]

Method Summary

WidgetCache	WidgetCache()	Constructor
array	&get_by_coll_container()
array	&get_by_coll_ID()
boolean	load_widget()	Loads appropriate widget class file.
void	&new_obj()	Instanciate a new object within this cache

[ Top ]

Properties

array $cache_container_Widget_array = array() [line 44]

Cache by container

[ Top ]

boolean $load_enabled_only [line 50]

Indicates whether to load enabled widgets only.

[ Top ]

Methods

Constructor WidgetCache [line 57]

WidgetCache WidgetCache(
[boolean
$enabled_only = false] 
)

Constructor

Parameters:

boolean

$enabled_only:

Load enabled widgets only?

[ Top ]

get_by_coll_container [line 167]

array &get_by_coll_container(
integer
$coll_ID, string
$container 
)

Parameters:

integer	$coll_ID:	Collection (blog) ID
string	$container:	Container

API Tags:

Return:

of Widget

[ Top ]

get_by_coll_ID [line 68]

array &get_by_coll_ID(
integer
$coll_ID 
)

Parameters:

integer

$coll_ID:

Collection (blog) ID

API Tags:

Return:

of coll_ID => array of container_name => array of Widget

[ Top ]

load_widget [line 144]

boolean load_widget(
string
$wi_code 
)

Loads appropriate widget class file.

Parameters:

string

$wi_code:

widget to load

API Tags:

Return:

Whether the class file could be loaded. Note that this method will return true if the file has been included before (there is no way to find out whether require_once() really included a file).

[ Top ]

new_obj [line 111]

void &new_obj(
[
$row = NULL] 
)

Instanciate a new object within this cache

Parameters:

$row:

Redefinition of:

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

[ Top ]

hic sunt dracones

	widgets

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