MVVFolder Class Reference

Inheritance diagram for MVVFolder:

Public Member Functions
	isSubfolderAllowed ($user_id)
	isFileDownloadable ($file_ref_id, $user_id)
	isReadable ($user_id)
	getDescriptionTemplate ()
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	availableInRange ($range_id_or_object, $user_id)
static	getTypeName ()
static	findTopFolder ($range_id)
static	createTopFolder ($range_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

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.

createTopFolder()

static createTopFolder (   $range_id )

static

Creates a root folder (top folder) for a mvv object referenced by its ID.

Parameters

string

$range_id

The ID of a mvv object for which a root folder shall be generated.

Returns

MVVFolder A new MVVFolder as root folder for a mvv object.

findTopFolder()

static findTopFolder (   $range_id )

static

Retrieves the top folder for a mvv object.

Parameters

string

$range_id

The mvv object-ID of the mvv object whose top folder shall be returned

Returns

MVVFolder|null The top folder of the mvv object identified by $range_id. If the folder can't be retrieved, null is returned.

getDescriptionTemplate()

getDescriptionTemplate

(

)

Returns a description template for PublicFolders.

Returns

string A string describing this folder type.

Implements FolderType.

getTypeName()

static getTypeName ( )

static

Returns a localised name of the PublicFolder type.

Returns

string The localised name of this folder type.

Implements FolderType.

isFileDownloadable()

isFileDownloadable	(		$file_ref_id,
			$user_id
	)

See method MVVFolder::isReadable

Implements FolderType.

isReadable()

isReadable

(

$user_id

)

Parameters

string

$user_id

Returns

bool

Implements FolderType.

isSubfolderAllowed()

isSubfolderAllowed

(

$user_id

)

Parameters

string

$user_id

Returns

bool

Implements FolderType.

---

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

• lib/filesystem/MVVFolder.php