Stud.IP  6.0
VirtualFolderType Class Reference
Inheritance diagram for VirtualFolderType:
FolderType

Public Member Functions

 __construct ($folderdata=[], $plugin_id=null)
 
 getIcon ($role='info')
 
 getId ()
 
 __get ($attribute)
 
 __set ($attribute, $value)
 
 isVisible ($user_id)
 
 isReadable ($user_id)
 
 isWritable ($user_id)
 
 isEditable ($user_id)
 
 isSubfolderAllowed ($user_id)
 
 getDescriptionTemplate ()
 
 getEditTemplate ()
 
 setDataFromEditTemplate ($request)
 
 validateUpload (FileType $file, $user_id)
 
 getSubfolders ()
 
 getFiles ()
 
 getParent ()
 
 addFile (FileType $file, $user_id=null)
 
 deleteFile ($file_ref_id)
 
 createSubfolder (FolderType $folderdata)
 
 deleteSubfolder ($subfolder_id)
 
 delete ()
 
 store ()
 
 isFileDownloadable ($fileref_or_id, $user_id)
 
 isFileEditable ($fileref_or_id, $user_id)
 
 isFileWritable ($fileref_or_id, $user_id)
 
 getAdditionalColumns ()
 
 getContentForAdditionalColumn ($column_index)
 
 getAdditionalColumnOrderWeigh ($column_index)
 
 getAdditionalActionButtons ()
 
 copySettings ()
 

Static Public Member Functions

static getTypeName ()
 
static availableInRange ($range_id_or_object, $user_id)
 

Protected Attributes

 $folderdata
 
 $plugin_id
 
 $files = []
 
 $subfolders = []
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $folderdata = [],
  $plugin_id = null 
)

VirtualFolderType constructor.

Parameters
array$folderdata
null$plugin_id

Member Function Documentation

◆ __get()

__get (   $attribute)
Parameters
$attribute
Returns
mixed

◆ __set()

__set (   $attribute,
  $value 
)
Parameters
$attribute
$value

◆ addFile()

addFile ( FileType  $file,
  $user_id = null 
)
Parameters
array | ArrayAccess$file
Returns
FileRef

Implements FolderType.

◆ availableInRange()

static availableInRange (   $range_id_or_object,
  $user_id 
)
static
Parameters
Object | string$range_id_or_object
string$user_id
Returns
bool

Implements FolderType.

◆ copySettings()

copySettings ( )

◆ createSubfolder()

createSubfolder ( FolderType  $folderdata)
Parameters
FolderType$folderdata
Returns
FolderType

Implements FolderType.

◆ delete()

delete ( )
Returns
bool

Implements FolderType.

◆ deleteFile()

deleteFile (   $file_ref_id)
Parameters
string$file_ref_id
Returns
bool

Implements FolderType.

◆ deleteSubfolder()

deleteSubfolder (   $subfolder_id)
Parameters
string$subfolder_id
Returns
bool

Implements FolderType.

◆ getAdditionalActionButtons()

getAdditionalActionButtons ( )

Returns an array of Studip or Studip objects that get displayed underneath the files-table.

Returns
array of Studip or Studip

Implements FolderType.

◆ getAdditionalColumnOrderWeigh()

getAdditionalColumnOrderWeigh (   $column_index)

Returns an integer that marks the value the content of the given column should be ordered by.

Parameters
string$column_index
Returns
integer : order value

Implements FolderType.

◆ getAdditionalColumns()

getAdditionalColumns ( )

Returns an associative array of additional colums with the index the id of the column and their values as the localized names of the columns

Returns
array('col1' => _("Anfragestatus"))

Implements FolderType.

◆ getContentForAdditionalColumn()

getContentForAdditionalColumn (   $column_index)

Returns the content for that additional column, if it exists. You can return null, a string or a Flexi as the content.

Parameters
string$column_index
Returns
null|string|Flexi

Implements FolderType.

◆ getDescriptionTemplate()

getDescriptionTemplate ( )
Returns
null

Implements FolderType.

◆ getEditTemplate()

getEditTemplate ( )
Returns
null

Implements FolderType.

◆ getFiles()

getFiles ( )
Returns
array

Implements FolderType.

◆ getIcon()

getIcon (   $role = 'info')
Parameters
string$role
Returns
Icon

Implements FolderType.

◆ getId()

getId ( )
Returns
mixed

Implements FolderType.

◆ getParent()

getParent ( )
Returns
null

Implements FolderType.

◆ getSubfolders()

getSubfolders ( )
Returns
array

Implements FolderType.

◆ getTypeName()

static getTypeName ( )
static
Returns
string

Implements FolderType.

◆ isEditable()

isEditable (   $user_id)
Parameters
string$user_id
Returns
bool

Implements FolderType.

◆ isFileDownloadable()

isFileDownloadable (   $fileref_or_id,
  $user_id 
)
Parameters
string$fileref_or_id
string$user_id
Returns
bool

Implements FolderType.

◆ isFileEditable()

isFileEditable (   $fileref_or_id,
  $user_id 
)
Parameters
string$fileref_or_id
string$user_id
Returns
bool

Implements FolderType.

◆ isFileWritable()

isFileWritable (   $fileref_or_id,
  $user_id 
)
Parameters
$fileref_or_id
string$user_id
Returns
bool

Implements FolderType.

◆ isReadable()

isReadable (   $user_id)
Parameters
string$user_id
Returns
bool

Implements FolderType.

◆ isSubfolderAllowed()

isSubfolderAllowed (   $user_id)
Parameters
string$user_id
Returns
bool

Implements FolderType.

◆ isVisible()

isVisible (   $user_id)
Parameters
$user_id
Returns
bool

Implements FolderType.

◆ isWritable()

isWritable (   $user_id)
Parameters
string$user_id
Returns
bool

Implements FolderType.

◆ setDataFromEditTemplate()

setDataFromEditTemplate (   $request)
Parameters
ArrayAccess | Request$request

Implements FolderType.

◆ store()

store ( )
Returns
bool

Implements FolderType.

◆ validateUpload()

validateUpload ( FileType  $file,
  $user_id 
)
Parameters
$uploadedfile
string$user_id
Returns
bool

Implements FolderType.

Field Documentation

◆ $files

$files = []
protected

◆ $folderdata

$folderdata
protected

◆ $plugin_id

$plugin_id
protected

◆ $subfolders

$subfolders = []
protected

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