Stud.IP  6.0
InboxFolder Class Reference
Inheritance diagram for InboxFolder:
InboxOutboxFolder FolderType

Public Member Functions

 getIcon ($role=Icon::DEFAULT_ROLE)
 
 getFiles ()
 
 __get ($attribute)
 
- Public Member Functions inherited from InboxOutboxFolder
 __construct ($folder)
 
 __get ($attribute)
 
 getIcon ($role=Icon::DEFAULT_ROLE)
 
 getId ()
 
 isVisible ($user_id)
 
 isReadable ($user_id)
 
 isWritable ($user_id)
 
 isEditable ($user_id)
 
 isSubfolderAllowed ($user_id)
 
 getDescriptionTemplate ()
 
 getParent ()
 
 getSubfolders ()
 
 getFiles ()
 
 getEditTemplate ()
 
 setDataFromEditTemplate ($folderdata)
 
 store ()
 
 validateUpload (FileType $file, $user_id)
 
 addFile (FileType $file, $user_id=null)
 
 deleteFile ($file_ref_id)
 
 createSubfolder (FolderType $folderdata)
 
 deleteSubfolder ($subfolder_id)
 
 delete ()
 
 isFileDownloadable ($file_ref_id, $user_id)
 
 isFileEditable ($file_ref_id, $user_id)
 
 isFileWritable ($file_ref_id, $user_id)
 
 getAdditionalColumns ()
 
 getContentForAdditionalColumn ($column_index)
 
 getAdditionalColumnOrderWeigh ($column_index)
 
 getAdditionalActionButtons ()
 
 copySettings ()
 

Static Public Member Functions

static getTypeName ()
 
- Static Public Member Functions inherited from InboxOutboxFolder
static getTypeName ()
 
static availableInRange ($range_id_or_object, $user_id)
 

Additional Inherited Members

- Protected Attributes inherited from InboxOutboxFolder
 $user = null
 
 $folder
 

Member Function Documentation

◆ __get()

__get (   $attribute)

The magic get method is overwritten to be able to set a custom value for the name attribute.

◆ getFiles()

getFiles ( )

Gets all attachments of received messages of a specific user and places the attachments inside this folder.

Returns
FileRef[] Array of FileRef objects representing the message attachments.

Implements FolderType.

◆ getIcon()

getIcon (   $role = Icon::DEFAULT_ROLE)

Returns the Icon object for the InboxFolder type.

Returns
Icon An icon object with the icon for this folder type.

Implements FolderType.

◆ getTypeName()

static getTypeName ( )
static

Returns a localised name of the InboxFolder type.

Returns
string The localised name of this folder type.

Implements FolderType.


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