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

Class: LinkCache

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

Class LinkCache

Class Overview

LinkCache Class

Located in /qp_inc/items/model/_linkcache.class.php [line 37]

DataObjectCache
   |
   --LinkCache
Author(s):
Information Tags:
Version:  beta

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 ]
Method Summary
LinkCache   LinkCache()   Constructor
void   add()   Add a dataobject to the cache
array   &get_by_item_ID()   Returns links for a given Item
void   load_by_item_ID()   Load links for a given Item
void   load_by_item_list()   Load links for a given Item list

[ Top ]
Methods
Constructor LinkCache  [line 49]

  LinkCache LinkCache( )

Constructor



[ Top ]
add  [line 58]

  void add( &$Obj  )

Add a dataobject to the cache

Parameters:
   &$Obj: 


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

[ Top ]
get_by_item_ID  [line 81]

  array &get_by_item_ID( integer $item_ID  )

Returns links for a given Item

Loads if necessary

Parameters:
integer   $item_ID:  item ID to load links for

API Tags:
Return:  of refs to Link objects

Information Tags:
Todo:  dh> does not get used anywhere (yet)?

[ Top ]
load_by_item_ID  [line 99]

  void load_by_item_ID( integer $item_ID  )

Load links for a given Item

Optimization: If the Item happens to be in the current MainList, Links for the whole MainList will be cached.

Parameters:
integer   $item_ID:  item ID to load links for

Information Tags:
Todo:  cache Link targets before letting the Link constructor handle it

[ Top ]
load_by_item_list  [line 153]

  void load_by_item_list( array $itemIDarray  )

Load links for a given Item list

Parameters:
array   $itemIDarray:  of of item IDs to load links for

Information Tags:
Todo:  cache Link targets before letting the Link constructor handle it

[ Top ]