Docs For Class FileRoot

Class Overview

This class provides info about a File Root.

A FileRoot describes a directory available for media file storage, under access permission.

Located in /blogs/inc/files/model/_fileroot.class.php [line 39]

Property Summary

mixed	$ads_path	Absolute path, ending with slash
mixed	$ads_url	Absolute URL, ending with slash
string	$ID	Unique Root ID constructed from type and in_type_ID
mixed	$in_type_ID	ID of user, group or collection.
mixed	$name	Name of the root
mixed	$type	Type: 'user', 'group' or 'collection'.

[ Top ]

Method Summary

static void	gen_ID()
FileRoot	FileRoot()	Constructor
void	get_typegroupname()

[ Top ]

Properties

mixed $ads_path [line 67]

Absolute path, ending with slash

[ Top ]

mixed $ads_url [line 72]

Absolute URL, ending with slash

[ Top ]

string $ID [line 57]

Unique Root ID constructed from type and in_type_ID

[ Top ]

mixed $in_type_ID [line 51]

ID of user, group or collection.

[ Top ]

mixed $name [line 62]

Name of the root

[ Top ]

mixed $type [line 46]

Type: 'user', 'group' or 'collection'.

Note: group is not implemented yet. Absolute will probably be deprecated.

[ Top ]

Methods

static method gen_ID [line 193]

static void gen_ID(

$root_type, 
$root_in_type_ID 
)

Parameters:

	$root_type:
	$root_in_type_ID:

[ Top ]

Constructor FileRoot [line 85]

FileRoot FileRoot(
string
$root_type, integer
$root_in_type_ID, [boolean
$create = true] 
)

Constructor

Will fail if non existent User or Blog is requested. But specific access permissions on (threfore existence of) this User or Blog should have been tested before anyway.

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...
boolean	$create:	Create the directory, if it does not exist yet?

[ Top ]

get_typegroupname [line 175]

void get_typegroupname(
)

[ Top ]

Multilingual multiuser multiblog engine

Class: FileRoot

Class FileRoot

Packages

Classes

Files