HiddenFolder Class Reference

Inheritance diagram for HiddenFolder:

Public Member Functions
	getIcon ($role=Icon::DEFAULT_ROLE)
	__construct ($folderdata=null)
	getDescriptionTemplate ()
	getEditTemplate ()
	setDataFromEditTemplate ($request)
	__get ($attribute)
	__set ($name, $value)
	isFileDownloadable ($fileref_or_id, $user_id)
Public Member Functions inherited from PermissionEnabledFolder
	__construct ($folderdata=null)
	getPermissionString ()
	checkPermission ($perm, $user_id=null)
	getIcon ($role=Icon::DEFAULT_ROLE)
	isVisible ($user_id=null)
	isReadable ($user_id=null)
	isWritable ($user_id=null)
	isSubfolderAllowed ($user_id)
	getDescriptionTemplate ()
	validateUpload (FileType $uploadedfile, $user_id)
	getEditTemplate ()
	getFiles ()
	isFileVisible ($fileref_or_id, $user_id)
	isFileDownloadable ($fileref_or_id, $user_id)
	copySettings ()
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 $file, $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 Public Member Functions inherited from PermissionEnabledFolder
static	availableInRange ($range_id_or_object, $user_id)
static	getTypeName ()
Static Public Member Functions inherited from StandardFolder
static	getTypeName ()
static	availableInRange ($range_id_or_object, $user_id)

Static Public Attributes
static	$sorter = 6
Static Public Attributes inherited from StandardFolder
static	$sorter = 0

Protected Attributes
	$permission = 0
Protected Attributes inherited from PermissionEnabledFolder
	$permission = 7
	$perms = ['x' => 1
	$must_have_perm => 2, 'r' => 4, 'f' => 8]
Protected Attributes inherited from StandardFolder
	$folderdata

Additional Inherited Members
Protected Member Functions inherited from StandardFolder
	isVisibleNonRecursive ($user_id)
	getValidationMessages ($upload_type, $newfile)

Constructor & Destructor Documentation

__construct()

__construct

(

$folderdata = null

)

HiddenFolder constructor.

Member Function Documentation

__get()

__get

(

$attribute

)

Parameters

$attribute

Returns

mixed

__set()

__set	(		$name,
			$value
	)

Parameters

$name
$value

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.

getDescriptionTemplate()

getDescriptionTemplate

(

)

Returns the description template for a instance of a HiddenFolder type

Returns

mixed A description template for a instance of the type HiddenFolder

Implements FolderType.

getEditTemplate()

getEditTemplate

(

)

Returns the edit template for this folder type.

Returns

Flexi

Implements FolderType.

getIcon()

getIcon

(

$role = Icon::DEFAULT_ROLE

)

This function returns the suitable Icon for this folder type (HiddenFolder)

Returns

Icon The icon object for this folder type

Implements FolderType.

getTypeName()

static getTypeName ( )

static

Returns the name of the HiddenFolder type.

Returns

string the name of the HiddenFolder type

Implements FolderType.

isFileDownloadable()

isFileDownloadable	(		$fileref_or_id,
			$user_id
	)

Parameters

$fileref_or_id
$user_id

Returns

bool

Implements FolderType.

setDataFromEditTemplate()

setDataFromEditTemplate

(

$request

)

Sets the data from a submitted edit template.

Parameters

array

$request

The data from the edit template.

Returns

FolderType

Implements FolderType.

Field Documentation

$permission

$permission = 0

protected

$sorter

$sorter = 6

static

---

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

• lib/filesystem/HiddenFolder.php