Stud.IP  5.4
 All Data Structures Namespaces Files Functions Variables Groups
Public Member Functions | Static Public Member Functions | Protected Attributes
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 (   $folderdata = [],
  $plugin_id = null 
)

VirtualFolderType constructor.

Parameters
array$folderdata
null$plugin_id

Member Function Documentation

__get (   $attribute)
Parameters
$attribute
Returns
mixed
__set (   $attribute,
  $value 
)
Parameters
$attribute
$value
addFile ( FileType  $file,
  $user_id = null 
)
Parameters
array | ArrayAccess$file
Returns
FileRef

Implements FolderType.

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

Implements FolderType.

copySettings ( )
See Also
FolderType::copySettings()

Implements FolderType.

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

Implements FolderType.

delete ( )
Returns
bool

Implements FolderType.

deleteFile (   $file_ref_id)
Parameters
string$file_ref_id
Returns
bool

Implements FolderType.

deleteSubfolder (   $subfolder_id)
Parameters
string$subfolder_id
Returns
bool

Implements FolderType.

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 (   $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 ( )

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 (   $column_index)

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

Parameters
string$column_index
Returns
null|string|Flexi_Template

Implements FolderType.

getDescriptionTemplate ( )
Returns
null

Implements FolderType.

getEditTemplate ( )
Returns
null

Implements FolderType.

getFiles ( )
Returns
array

Implements FolderType.

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

Implements FolderType.

getId ( )
Returns
mixed

Implements FolderType.

getParent ( )
Returns
null

Implements FolderType.

getSubfolders ( )
Returns
array

Implements FolderType.

static getTypeName ( )
static
Returns
string

Implements FolderType.

isEditable (   $user_id)
Parameters
string$user_id
Returns
bool

Implements FolderType.

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

Implements FolderType.

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

Implements FolderType.

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

Implements FolderType.

isReadable (   $user_id)
Parameters
string$user_id
Returns
bool

Implements FolderType.

isSubfolderAllowed (   $user_id)
Parameters
string$user_id
Returns
bool

Implements FolderType.

isVisible (   $user_id)
Parameters
$user_id
Returns
bool

Implements FolderType.

isWritable (   $user_id)
Parameters
string$user_id
Returns
bool

Implements FolderType.

setDataFromEditTemplate (   $request)
Parameters
ArrayAccess | Request$request

Implements FolderType.

store ( )
Returns
bool

Implements FolderType.

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

Implements FolderType.

Field Documentation

$files = []
protected
$folderdata
protected
$plugin_id
protected
$subfolders = []
protected
The documentation for this class was generated from the following file: