Docs For Class FileCache

Class Overview

FileCache Class

Located in /blogs/inc/MODEL/files/_filecache.class.php [line 41]

DataObjectCache
   |
   --FileCache

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::$dbIDname DataObjectCache::$dbprefix DataObjectCache::$dbtablename DataObjectCache::$load_add DataObjectCache::$name_field 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_ID_array() Get an array of all (loaded) IDs. 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() TODO DataObjectCache::option_list() Display form option list with cache contents DataObjectCache::option_list_return() Returns form option list with cache contents DataObjectCache::remove_by_ID() Remove an object from cache by ID

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From DataObjectCache

DataObjectCache::$all_loaded

DataObjectCache::$cache

DataObjectCache::$dbIDname

DataObjectCache::$dbprefix

DataObjectCache::$dbtablename

DataObjectCache::$load_add

DataObjectCache::$name_field

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_ID_array()

Get an array of all (loaded) IDs.

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()

TODO

DataObjectCache::option_list()

Display form option list with cache contents

DataObjectCache::option_list_return()

Returns form option list with cache contents

DataObjectCache::remove_by_ID()

Remove an object from cache by ID

[ Top ]

Method Summary

FileCache	FileCache()	Constructor
File	&get_by_root_and_path()	Creates an object of the File class, while providing caching and making sure that only one reference to a file exists.
Object	&instantiate()	Instantiate a DataObject from a table row and then cache it.

[ Top ]

Properties

Methods

Constructor FileCache [line 53]

FileCache FileCache(
)

Constructor

[ Top ]

get_by_root_and_path [line 101]

File &get_by_root_and_path(
string
$root_type, integer
$root_in_type_ID, string
$rel_path, [boolean
$load_meta = false] 
)

Creates an object of the File class, while providing caching and making sure that only one reference to a file exists.

Parameters:

string	$root_type:	Root type: 'user', 'group' or 'collection'
integer	$root_in_type_ID:	ID of the user, the group or the collection the file belongs to...
string	$rel_path:	Subpath for this file/folder, relative the associated root, including trailing slash (if directory)
boolean	$load_meta:	check for meta data?

API Tags:

Return:

an File object

[ Top ]

instantiate [line 65]

Object &instantiate(
Object
&$db_row 
)

Instantiate a DataObject from a table row and then cache it.

Parameters:

Object

&$db_row:

Database row

Redefinition of:

DataObjectCache::instantiate(): Instantiate a DataObject from a table row and then cache it.

[ Top ]

Multilingual multiuser multiblog engine

Class: FileCache

Class FileCache

Packages

Classes

Files