Stud.IP  jlu_4.3 Revision 64286
HiddenFolder Class Reference
Inheritance diagram for HiddenFolder:
Inheritance graph
Collaboration diagram for HiddenFolder:
Collaboration graph

Public Member Functions

 getIcon ($role=Icon::DEFAULT_ROLE)
 
 __construct ($folderdata=null)
 
 getDescriptionTemplate ()
 
 getEditTemplate ()
 
- 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 ()
 
 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)
 

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, 'w' => 2, 'r' => 4, 'f' => 8]
 
 $must_have_perm
 
- Protected Attributes inherited from StandardFolder
 $folderdata
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $folderdata = null)

HiddenFolder constructor.

Reimplemented from PermissionEnabledFolder.

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" or "resource"
string$user_id
Returns
boolean True, if creatable, false otherwise.

Reimplemented from PermissionEnabledFolder.

Here is the call graph for this function:

◆ 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

Reimplemented from PermissionEnabledFolder.

Here is the call graph for this function:

◆ getEditTemplate()

getEditTemplate ( )

This method returns the special part for the edit template for the folder type GroupFolder

Reimplemented from PermissionEnabledFolder.

◆ 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

Reimplemented from PermissionEnabledFolder.

Here is the call graph for this function:

◆ getTypeName()

static getTypeName ( )
static

Returns the name of the HiddenFolder type.

Returns
string the name of the HiddenFolder type

Reimplemented from PermissionEnabledFolder.

Here is the caller graph for this function:

Field Documentation

◆ $permission

$permission = 0
protected

◆ $sorter

$sorter = 6
static

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