TimedFolder Class Reference

Inheritance diagram for TimedFolder:

Collaboration diagram for TimedFolder:

Public Member Functions
	isVisible ($user_id=null)
	getIcon ($role=Icon::DEFAULT_ROLE)
	__construct ($folderdata=null)
	getDescriptionTemplate ()
	getEditTemplate ()
	setDataFromEditTemplate ($request)
Public Member Functions inherited from PermissionEnabledFolder
	__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	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)

Data Fields
	$start_time
	$end_time

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

Additional Inherited Members
Protected Member Functions inherited from PermissionEnabledFolder
	checkPermission ($perm, $user_id=null)
Protected Attributes inherited from PermissionEnabledFolder
	$permission = 7
	$perms = ['x' => 1, 'w' => 2, 'r' => 4, 'f' => 8]
	$must_have_perm
Protected Attributes inherited from StandardFolder
	$folderdata

Constructor & Destructor Documentation

__construct()

__construct

(

$folderdata = null

)

TimedFolder constructor.

Parameters

array | null

$folderdata

data to create folder with

Reimplemented from PermissionEnabledFolder.

Member Function Documentation

availableInRange()

static availableInRange (   $range_id_or_object,   $user_id  )

static

Provides the ranges this folder type is available in for the given user. Doesn't really make sense in other contexts than a course.

Parameters

string	$range_id_or_object	the object (or object ID) to check for
	$user_id	the user to check for (must have at least 'tutor' perm in given course)

Returns

bool available or not?

Reimplemented from PermissionEnabledFolder.

Here is the call graph for this function:

getDescriptionTemplate()

getDescriptionTemplate

(

)

Returns the description template for a instance of a TimedFolder type.

Returns

Flexi_Template A description template for a instance of the type TimedFolder

Reimplemented from PermissionEnabledFolder.

Here is the call graph for this function:

getEditTemplate()

getEditTemplate

(

)

Returns the edit template for this folder type.

Returns

Flexi_Template

Reimplemented from PermissionEnabledFolder.

getIcon()

getIcon

(

$role = Icon::DEFAULT_ROLE

)

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

Returns

Icon The icon object for this folder type

Reimplemented from PermissionEnabledFolder.

Here is the call graph for this function:

getTypeName()

static getTypeName ( )

static

Returns the name of the TimedFolder type.

Returns

string the name of the TimedFolder type

Reimplemented from PermissionEnabledFolder.

Here is the caller graph for this function:

isVisible()

isVisible

(

$user_id = null

)

Is the current folder visible for the given user? That depends on parent folder visibility and time settings.

Parameters

string | null

$user_id

the user to check visibility for

Returns

bool visible or not?

Reimplemented from PermissionEnabledFolder.

setDataFromEditTemplate()

setDataFromEditTemplate

(

$request

)

Stores the data which was edited in the edit template

Returns

mixed The template with the edited data

Reimplemented from StandardFolder.

Here is the call graph for this function:

Field Documentation

$end_time

$end_time

$sorter

$sorter = 5

static

$start_time

$start_time

---

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

• lib/filesystem/TimedFolder.php