Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
InstitutePublicFolder Class Reference
Inheritance diagram for InstitutePublicFolder:
CoursePublicFolder StandardFolder FolderType

Public Member Functions

 isVisible ($user_id)
 
 getDescriptionTemplate ()
 
- Public Member Functions inherited from CoursePublicFolder
 getIcon ($role=Icon::DEFAULT_ROLE)
 
 hasWorldwideAccess ()
 
 isVisible ($user_id)
 
 isReadable ($user_id)
 
 getDescriptionTemplate ()
 
 getEditTemplate ()
 
 setDataFromEditTemplate ($request)
 
 isFileDownloadable ($file_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 (FileType $newfile, $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 getTypeName ()
 
static availableInRange ($range_id_or_object, $user_id)
 
- Static Public Member Functions inherited from CoursePublicFolder
static getTypeName ()
 
static availableInRange ($range_id_or_object, $user_id)
 
- Static Public Member Functions inherited from StandardFolder
static getTypeName ()
 
static availableInRange ($range_id_or_object, $user_id)
 

Additional Inherited Members

- Static Public Attributes inherited from CoursePublicFolder
static $sorter = 7
 
- Static Public Attributes inherited from StandardFolder
static $sorter = 0
 
- Protected Member Functions inherited from StandardFolder
 isVisibleNonRecursive ($user_id)
 
 getValidationMessages ($upload_type, $newfile)
 
- Protected Attributes inherited from StandardFolder
 $folderdata
 

Member Function Documentation

static availableInRange (   $range_id_or_object,
  $user_id 
)
static

Determines if this folder type is available for a user and the object that is either referenced by its ID or whose data is passed to this method.

Parameters
mixed$range_id_or_objectThe obect to be checked.
string$user_idThe user for which the availability of this folder type shall be checked.
Returns
bool True, if the folder type is available, false otherwise.

Implements FolderType.

getDescriptionTemplate ( )

Returns a description template for InstitutePublicFolder.

Returns
string A string describing this folder type.

Implements FolderType.

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.

isVisible (   $user_id)

Determines the visibility of an InstitutePublicFolder. An InstitutePublicFolder is visible for all logged in users and in case ENABLE_FREE_ACCESS is set to '1' or the worldwide access option is set.

Parameters
string$user_idThe user who wishes to see the folder.
Returns
bool True, in case the user may see the folder, false otherwise.

Implements FolderType.


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