Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
FilesystemPlugin Interface Reference

Public Member Functions

 getFileSelectNavigation ()
 
 filesystemConfigurationURL ()
 
 isSource ()
 
 isPersonalFileArea ()
 
 getFolder ($folder_id=null)
 
 getPreparedFile ($file_id, $with_blob=false)
 
 hasSearch ()
 
 getSearchParameters ()
 
 search ($text, $parameters=[])
 

Member Function Documentation

filesystemConfigurationURL ( )

Returns an URL to a page, where the filesystem can be configured.

Returns
mixed
getFileSelectNavigation ( )

Returns a Navigation-object. Only the title and the image will be used.

Returns
null|Navigation with title and image
getFolder (   $folder_id = null)

This method is used to get a folder-object for this plugin. Not recommended but still possible is to return a Flexi_Template for the folder, if you want to take care of the frontend of displaying the folder as well.

Parameters
null$folder_id: folder_id of folder to get or null if you want the top-folder
Returns
FolderType|Flexi_Template
getPreparedFile (   $file_id,
  $with_blob = false 
)
Parameters
$file_id: The id for the file in the given filesystem of the plugin.
Returns
array : the already prepared File just like a file-upload-array
getSearchParameters ( )

Returns an array for each special search parameter. Each parameter is itself represented by as associative array like array( 'name' => "name of this parameter in the form", 'type' => "one of 'text', 'checkbox', 'select'", 'options' => array() //only neccesary if type is 'select' - a key-value array with the key key as the value of the select and the value as the label of the option 'placeholder' => "only possible for type 'text' but not mandatory" ) This method can also return an empty array or null if no search parameters are needed or no search is provided at all.

Returns
null|array(array(), ...)
hasSearch ( )

Defines if the filesystem-plugin has a search-function.

Returns
mixed
isPersonalFileArea ( )

Determines if this filesystem-plugin should show up as a personal file-area and be a destination for copied files. This may be dependend on the current user and his/her configurations.

Returns
boolean
isSource ( )

Determines if this filesystem plugin should be a source for copying or a search. This may be dependend on the current user and his/her configurations.

Returns
boolean
search (   $text,
  $parameters = [] 
)

Returns a virtual folder that 'contains' all the files as a search-result. Only return null if search is not implemented.

Parameters
string$texta string
array$parameters: an associative array of additional search parameters as defined in getSearchParameters()
Returns
FolderType|null

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