RootFolder Class Reference

Inheritance diagram for RootFolder:

Public Member Functions
	__get ($attribute)
	isWritable ($user_id)
	isEditable ($user_id)
	getParent ()
	store ()
	getEditTemplate ()
	setDataFromEditTemplate ($request)
Public Member Functions inherited from StandardFolder
	__construct ($folderdata=null)
	getIcon ($role=Icon::DEFAULT_ROLE)
	getId ()
	__get ($attribute)
	__set ($name, $value)
	isVisible ($user_id)
	isReadable ($user_id)
	isWritable ($user_id)
	isEditable ($user_id)
	isSubfolderAllowed ($user_id)
	getDescriptionTemplate ()
	getEditTemplate ()
	setDataFromEditTemplate ($request)
	store ()
	validateUpload (FileType $newfile, $user_id)
	getSubfolders ()
	getFiles ()
	getParent ()
	addFile (FileType $file, $user_id=null)
	deleteFile ($file_ref_id)
	createSubfolder (FolderType $foldertype)
	deleteSubfolder ($subfolder_id)
	delete ()
	isFileDownloadable ($fileref_or_id, $user_id)
	isFileEditable ($fileref_or_id, $user_id)
	isFileWritable ($fileref_or_id, $user_id)
	getRangeObject ()
	getAdditionalColumns ()
	getContentForAdditionalColumn ($column_index)
	getAdditionalColumnOrderWeigh ($column_index)
	getAdditionalActionButtons ()
	copySettings ()

Static Public Member Functions
static	getTypeName ()
static	availableInRange ($range_id_or_object, $user_id)
Static Public Member Functions inherited from StandardFolder
static	getTypeName ()
static	availableInRange ($range_id_or_object, $user_id)

Additional Inherited Members
Static Public Attributes inherited from StandardFolder
static	$sorter = 0
Protected Member Functions inherited from StandardFolder
	isVisibleNonRecursive ($user_id)
	getValidationMessages ($upload_type, $newfile)
Protected Attributes inherited from StandardFolder
	$folderdata

Member Function Documentation

__get()

__get

(

$attribute

)

Parameters

string

$attribute

Returns

mixed

availableInRange()

static availableInRange (   $range_id_or_object,   $user_id  )

static

This method tells if the FolderType implementation can be created in a specific range type.

Some FolderType implementations aren't useful in conjunction with a specific range type. An FolderType implementation therefore must provide this method so that other parts of the file area system can easily check if folders of the FolderType implementation can be placed inside standard folders.

Parameters

string | Object	$range_id_or_object	id or object of type "course", "user", "institute", "message"
string	$user_id

Returns

boolean True, if creatable, false otherwise.

Implements FolderType.

getEditTemplate()

getEditTemplate

(

)

Returns

Flexi_Template

Implements FolderType.

getParent()

getParent

(

)

Returns the parent-folder as a StandardFolder

Returns

FolderType

Implements FolderType.

getTypeName()

static getTypeName ( )

static

Returns

string

Implements FolderType.

isEditable()

isEditable

(

$user_id

)

Parameters

string

$user_id

Returns

bool

Implements FolderType.

isWritable()

isWritable

(

$user_id

)

Parameters

string

$user_id

Returns

bool

Implements FolderType.

setDataFromEditTemplate()

setDataFromEditTemplate

(

$request

)

Parameters

array

$request

Returns

FolderType|MessageBox

Implements FolderType.

store()

store

(

)

Returns

bool|number

Implements FolderType.

---

The documentation for this class was generated from the following file:

• lib/filesystem/RootFolder.php