PHP Класс Gollem_Api, horde

This file defines Gollem's external API interface. Other applications can interact with Gollem through this API. Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
Автор: Amith Varghese ([email protected])
Автор: Michael Slusarz ([email protected])
Автор: Ben Klang ([email protected])
Наследование: extends Horde_Registry_Api
Показать файл Открыть проект

Открытые методы

Метод Описание
browse ( string $path = '', array $properties = ['name', 'icon', 'browseable'] ) : array Browses through the VFS tree.
getViewLink ( string $dir, string $file, string $backend_key = '' ) : Horde_Url Returns a link to the gollem file preview interface
mkcol ( string $path ) Creates a directory ("collection" in WebDAV-speak) within the VFS
move ( string $path, string $dest ) Renames a file or directory
path_delete ( string $path ) Removes a file or folder from the VFS
put ( string $path, string $content, string $content_type ) Accepts a file for storage into the VFS.
returnFromSelectlist ( string $selectid, integer $index ) : string Returns the data for a given selection ID and index.
selectlistLink ( string $link_text, string $link_style, string $formid, boolean $icon = false, string $selectid = '' ) : string Creates a link to the gollem file selection window.
selectlistResults ( string $selectid ) Returns the list of files selected by the user for a given selection ID.
setSelectlist ( string $selectid = '', array $files = [] ) : string Sets the files selected for a given selection ID.

Защищенные методы

Метод Описание
_getBackend ( $path )

Описание методов

_getBackend() защищенный Метод

protected _getBackend ( $path )

browse() публичный Метод

Each VFS backend is listed as a directory at the top level. No modify operations are allowed outside any VFS area.
public browse ( string $path = '', array $properties = ['name', 'icon', 'browseable'] ) : array
$path string The level of the tree to browse.
$properties array The item properties to return. Defaults to 'name', 'icon', and 'browseable'.
Результат array The contents of $path.

mkcol() публичный Метод

Creates a directory ("collection" in WebDAV-speak) within the VFS
public mkcol ( string $path )
$path string Path of directory to create

move() публичный Метод

Renames a file or directory
public move ( string $path, string $dest )
$path string Path to source object to be renamed
$dest string Path to new name

path_delete() публичный Метод

Removes a file or folder from the VFS
public path_delete ( string $path )
$path string Path of file or folder to delete

put() публичный Метод

Accepts a file for storage into the VFS.
public put ( string $path, string $content, string $content_type )
$path string Path to store file.
$content string Contents of file.
$content_type string MIME type of file.

returnFromSelectlist() публичный Метод

Returns the data for a given selection ID and index.
public returnFromSelectlist ( string $selectid, integer $index ) : string
$selectid string The selection ID.
$index integer The index of the file data to return.
Результат string The file data.

selectlistResults() публичный Метод

Returns the list of files selected by the user for a given selection ID.
public selectlistResults ( string $selectid )
$selectid string The selection ID.

setSelectlist() публичный Метод

Sets the files selected for a given selection ID.
public setSelectlist ( string $selectid = '', array $files = [] ) : string
$selectid string The selection ID to use.
$files array An array with each file entry stored in its own array, with the key as the directory name and the value as the filename.
Результат string The selection ID.