PermissionEnabledFolder Class Reference

Inheritance diagram for PermissionEnabledFolder:

Collaboration diagram for PermissionEnabledFolder:

Public Member Functions
	__construct ($folderdata=null)
	getPermissionString ()
	getIcon ($role=Icon::DEFAULT_ROLE)
	isVisible ($user_id=null)
	isReadable ($user_id=null)
	isWritable ($user_id=null)
	isSubfolderAllowed ($user_id=null)
	getDescriptionTemplate ()
	validateUpload ($uploadedfile, $user_id)
	getEditTemplate ()
	isFileDownloadable ($fileref_or_id, $user_id)
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 ($uploadedfile, $user_id)
	getSubfolders ()
	getFiles ()
	getParent ()
	createFile ($file)
	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 ()
	getIcon ($role)
	getId ()
	isVisible ($user_id)
	isReadable ($user_id)
	isWritable ($user_id)
	isEditable ($user_id)
	isSubfolderAllowed ($user_id)
	getDescriptionTemplate ()
	getSubfolders ()
	getFiles ()
	getParent ()
	getEditTemplate ()
	setDataFromEditTemplate ($folderdata)
	validateUpload ($file, $user_id)
	createFile ($file)
	deleteFile ($file_ref_id)
	createSubfolder (FolderType $foldertype)
	deleteSubfolder ($subfolder_id)
	delete ()
	store ()
	isFileDownloadable ($file_ref_id, $user_id)
	isFileEditable ($file_ref_id, $user_id)
	isFileWritable ($file_ref_id, $user_id)

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

Protected Member Functions
	checkPermission ($perm, $user_id=null)

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

Additional Inherited Members
Static Public Attributes inherited from StandardFolder
static	$sorter = 0

Constructor & Destructor Documentation

__construct()

__construct

(

$folderdata = null

)

StandardFolder constructor.

Parameters

Folder | StandardFolder | null

$folderdata

Reimplemented from StandardFolder.

Reimplemented in HiddenFolder, HomeworkFolder, MaterialFolder, and TimedFolder.

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.

Reimplemented from StandardFolder.

Reimplemented in HiddenFolder, HomeworkFolder, MaterialFolder, and TimedFolder.

checkPermission()

checkPermission (   $perm,   $user_id = null  )

protected

Here is the caller graph for this function:

getDescriptionTemplate()

getDescriptionTemplate

(

)

Returns

string|Flexi_Template

Reimplemented from StandardFolder.

Reimplemented in HiddenFolder, HomeworkFolder, MaterialFolder, and TimedFolder.

Here is the call graph for this function:

getEditTemplate()

getEditTemplate

(

)

Returns

string|Flexi_Template

Reimplemented from StandardFolder.

Reimplemented in HiddenFolder, HomeworkFolder, MaterialFolder, and TimedFolder.

getIcon()

getIcon

(

$role = Icon::DEFAULT_ROLE

)

Parameters

string

$role

Returns

Icon

Reimplemented from StandardFolder.

Reimplemented in HiddenFolder, HomeworkFolder, MaterialFolder, and TimedFolder.

Here is the call graph for this function:

getPermissionString()

getPermissionString

(

)

getTypeName()

static getTypeName ( )

static

Returns

string

Reimplemented from StandardFolder.

Reimplemented in HiddenFolder, HomeworkFolder, MaterialFolder, and TimedFolder.

Here is the caller graph for this function:

isFileDownloadable()

isFileDownloadable	(		$fileref_or_id,
			$user_id
	)

Parameters

$fileref_or_id
$user_id

Returns

bool

Reimplemented from StandardFolder.

Here is the call graph for this function:

isReadable()

isReadable

(

$user_id = null

)

Parameters

string

$user_id

Returns

bool

Reimplemented from StandardFolder.

Here is the call graph for this function:

Here is the caller graph for this function:

isSubfolderAllowed()

isSubfolderAllowed

(

$user_id = null

)

Parameters

string

$user_id

Returns

bool

Reimplemented from StandardFolder.

Reimplemented in HomeworkFolder.

Here is the call graph for this function:

isVisible()

isVisible

(

$user_id = null

)

Parameters

string

$user_id

Returns

bool

Reimplemented from StandardFolder.

Reimplemented in TimedFolder.

Here is the call graph for this function:

Here is the caller graph for this function:

isWritable()

isWritable

(

$user_id = null

)

Parameters

string

$user_id

Returns

bool

Reimplemented from StandardFolder.

Here is the call graph for this function:

Here is the caller graph for this function:

validateUpload()

validateUpload	(		$uploadedfile,
			$user_id
	)

Parameters

array	$uploadedfile
string	$user_id

Returns

string

Reimplemented from StandardFolder.

Here is the call graph for this function:

Field Documentation

$must_have_perm

$must_have_perm

protected

$permission

$permission = 7

protected

$perms

$perms = ['x' => 1, 'w' => 2, 'r' => 4, 'f' => 8]

protected

---

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

• lib/filesystem/PermissionEnabledFolder.php