Docs For Class FileRootCache

Class Overview

This class provides info about File Roots.

These are root directories available for media file storage, under access permission.

[ Top ]

Property Summary

array

[ Top ]

Method Summary

FileRoot\|false	&get_by_ID()	Get a FileRoot (cached) by ID.
FileRoot\|false	&get_by_type_and_ID()	Get a FileRoot (cached).
string	get_root_dir()	Get the absolute path (FileRoot::ads_path) to a given root (with ending slash).

[ Top ]

Properties

array $cache = array() [line 51]

[ Top ]

Methods

get_by_ID [line 60]

FileRoot|false &get_by_ID(
string
$id 
)

Get a FileRoot (cached) by ID.

Parameters:

string

$id:

ID of the FileRoot (e.g. 'user_X' or 'collection_X')

API Tags:

Return:

FileRoot on success, false on failure (ads_path is false).

[ Top ]

get_by_type_and_ID [line 77]

FileRoot|false &get_by_type_and_ID(
string
$root_type, integer
$root_in_type_ID 
)

Get a FileRoot (cached).

Parameters:

string	$root_type:	Root type: 'user', 'group', 'collection' or 'absolute'
integer	$root_in_type_ID:	ID of the user, the group or the collection the file belongs to...

API Tags:

Return:

FileRoot on success, false on failure (ads_path is false).

[ Top ]

get_root_dir [line 100]

string get_root_dir(

$root_type, 
$root_in_type_ID 
)

Get the absolute path (FileRoot::ads_path) to a given root (with ending slash).

Parameters:

	$root_type:
	$root_in_type_ID:

[ Top ]

Multilingual multiuser multiblog engine