Filemanager_Frontend_Json
backend class for Zend_Json_Server
This class handles all Json requests for the Filemanager application
Implements:
Tinebase_Frontend_Json_Interface, Tinebase_Frontend_Interface
Extend:
Tinebase_Frontend_Json_Abstract
Methods
Name | Description |
---|---|
copyNodes | copy node(s) |
createNode | create node |
createNodes | create nodes |
deleteDownloadLinks | deletes existing records |
deleteNodes | delete node(s) |
getDownloadLink | Return a single record |
getFolderUsage | Return usage array of a folder |
getNode | returns the node record |
getParentNodeByFilter | |
moveNodes | move node(s) |
saveDownloadLink | creates/updates a record |
saveNode | save node |
searchDownloadLinks | Search for records matching given arguments |
searchNodes | search file/directory nodes |
Inherited methods
Name | Description |
---|---|
__call | magic method for json api |
addFilterModelPlugin | Add a plugin for a former filter |
getModelsConfiguration | returns model configurations for application starter |
getRegistryData | Returns registry data of the application. |
getRelatableModels | Returns all relatable models for this app |
getTemplates | get available templates by containerId |
resolveContainersAndTags | resolve containers and tags |
Filemanager_Frontend_Json::copyNodes
Description
public copyNodes (string|array $sourceFilenames, string|array $destinationFilenames, bool $forceOverwrite)
copy node(s)
Parameters
(string|array) $sourceFilenames
: string->single file, array->multiple(string|array) $destinationFilenames
: string->singlefile OR directory, array->multiple files(bool) $forceOverwrite
Return Values
array
Filemanager_Frontend_Json::createNode
Description
public createNode (array $filename, string $type, string $tempFileId, bool $forceOverwrite)
create node
Parameters
(array) $filename
(string) $type
: mimetype(string) $tempFileId
(bool) $forceOverwrite
Return Values
array
Filemanager_Frontend_Json::createNodes
Description
public createNodes (string|array $filenames, string|array $type, string|array $tempFileIds, bool $forceOverwrite)
create nodes
Parameters
(string|array) $filenames
(string|array) $type
: directory or mime type in case of a file(string|array) $tempFileIds
(bool) $forceOverwrite
Return Values
array
Filemanager_Frontend_Json::deleteDownloadLinks
Description
public deleteDownloadLinks (array $ids)
deletes existing records
Parameters
(array) $ids
Return Values
array
Filemanager_Frontend_Json::deleteNodes
Description
public deleteNodes (string|array $filenames)
delete node(s)
Parameters
(string|array) $filenames
: string->single file, array->multiple
Return Values
array
Filemanager_Frontend_Json::getDownloadLink
Description
public getDownloadLink (string $id)
Return a single record
Parameters
(string) $id
Return Values
array
record data
Filemanager_Frontend_Json::getFolderUsage
Description
public getFolderUsage ( $_id)
Return usage array of a folder
Parameters
() $_id
Return Values
array
of folder usage
Filemanager_Frontend_Json::getNode
Description
public getNode (string $id)
returns the node record
Parameters
(string) $id
Return Values
array
Throws Exceptions
\Tinebase_Exception_NotFound
Filemanager_Frontend_Json::getParentNodeByFilter
Description
getParentNodeByFilter (void)
Parameters
This function has no parameters.
Return Values
void
Filemanager_Frontend_Json::moveNodes
Description
public moveNodes (string|array $sourceFilenames, string|array $destinationFilenames, bool $forceOverwrite)
move node(s)
Parameters
(string|array) $sourceFilenames
: string->single file, array->multiple(string|array) $destinationFilenames
: string->singlefile OR directory, array->multiple files(bool) $forceOverwrite
Return Values
array
Filemanager_Frontend_Json::saveDownloadLink
Description
public saveDownloadLink (array $recordData)
creates/updates a record
Parameters
(array) $recordData
Return Values
array
created/updated record
Filemanager_Frontend_Json::saveNode
Description
public saveNode (array $recordData)
save node
save node here in json fe just updates meta info (name, description, relations, customfields, tags, notes),
if record already exists (after it had been uploaded)
Parameters
(array) $recordData
: with record data
Return Values
array
Filemanager_Frontend_Json::searchDownloadLinks
Description
public searchDownloadLinks (array $filter, array $paging)
Search for records matching given arguments
Parameters
(array) $filter
(array) $paging
Return Values
array
Filemanager_Frontend_Json::searchNodes
Description
public searchNodes (array $filter, array $paging)
search file/directory nodes
Parameters
(array) $filter
(array) $paging
Return Values
array