Docs For Class FiletypeCache

Class Overview

FiletypeCache Class

Located in /blogs/inc/files/model/_filetypecache.class.php [line 43]

DataObjectCache
   |
   --FiletypeCache

Author(s):

Information Tags:

Version:

beta

Properties

$extension_cache

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::$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.

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

$extension_cache

[ Top ]

Method Summary

FiletypeCache	FiletypeCache()	Constructor
void	add()	Add a dataobject to the cache
reference	&get_by_extension()	Get an object from cache by extensions ID
reference	&get_by_mimetype()	Get an object from cache by mimetype.

[ Top ]

Properties

mixed $extension_cache = array() [line 45]

[ Top ]

Methods

Constructor FiletypeCache [line 50]

FiletypeCache FiletypeCache(
)

Constructor

[ Top ]

add [line 60]

void add(

&$Obj 
)

Add a dataobject to the cache

Parameters:

&$Obj:

Redefinition of:

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

[ Top ]

get_by_extension [line 103]

reference &get_by_extension(
string
$req_ID, [boolean
$halt_on_error = true], [boolean
$halt_on_empty = true] 
)

Get an object from cache by extensions ID

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

Parameters:

string	$req_ID:	Extension string 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

API Tags:

Return:

on cached object

[ Top ]

get_by_mimetype [line 143]

reference &get_by_mimetype(
string
$mimetype, [boolean
$halt_on_error = true], [boolean
$halt_on_empty = true] 
)

Get an object from cache by mimetype.

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

Parameters:

string	$mimetype:	Mimetype string 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

API Tags:

Return:

on cached object

Information Tags:

Todo:

dh> this copies nearly the whole code of get_by_extension! Have not checked DataObjectCache, but this needs refactoring.

[ Top ]

Multilingual multiuser multiblog engine

Class: FiletypeCache

Class FiletypeCache

Packages

Classes

Files