Stud.IP  4.2 Revision
CourseDateFolder Class Reference
Inheritance diagram for CourseDateFolder:
Inheritance graph
Collaboration diagram for CourseDateFolder:
Collaboration graph

Public Member Functions

 __construct ($folderdata=null)
 
 getIcon ($role=Icon::DEFAULT_ROLE)
 
 getDate ()
 
 setDate (CourseDate $date)
 
 getEditTemplate ()
 
 setDataFromEditTemplate ($request)
 
 getDescriptionTemplate ()
 
- 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 ($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 ()
 

Static Public Member Functions

static formatDate (CourseDate $date)
 
static getTypeName ()
 
static availableInRange ($range_id_or_object, $user_id)
 
- 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 = 1
 
- Static Public Attributes inherited from StandardFolder
static $sorter = 0
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ __construct()

__construct (   $folderdata = null)
Here is the call graph for this function:

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_objectid or object of type "course", "user", "institute", "message"
string$user_id
Returns
boolean True, if creatable, false otherwise.

Implements FolderType.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ formatDate()

static formatDate ( CourseDate  $date)
static
Here is the call graph for this function:

◆ getDate()

getDate ( )
Returns
CourseDate
Here is the call graph for this function:
Here is the caller graph for this function:

◆ getDescriptionTemplate()

getDescriptionTemplate ( )

Returns the description template

Returns
Flexi_Template description template

Implements FolderType.

Here is the call graph for this function:

◆ getEditTemplate()

getEditTemplate ( )

This method returns the special part for the edit template

Returns
Flexi_Template edit template

Implements FolderType.

Here is the call graph for this function:

◆ getIcon()

getIcon (   $role = Icon::DEFAULT_ROLE)

Returns the name of the icon shape that shall be used with the FolderType implementation.

Parameters
string$rolerole of icon
Returns
Icon icon for the FolderType implementation.

Implements FolderType.

Here is the call graph for this function:

◆ getTypeName()

static getTypeName ( )
static

Returns a human-friendly representation of the FolderType's name.

Returns
string A human-friendly name for the FolderType implementation.

Implements FolderType.

◆ setDataFromEditTemplate()

setDataFromEditTemplate (   $request)

Stores the data which was edited in the edit template

Returns
FolderType|MessageBox The template with the edited data

Implements FolderType.

Here is the call graph for this function:

◆ setDate()

setDate ( CourseDate  $date)
Parameters
CourseDate$date
Returns
CourseDate
Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

◆ $sorter

$sorter = 1
static

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