File/lib/api.php

Description
Description | Functions

Gollem external API interface.

This file defines Gollem's external API interface. Other applications can interact with Gollem through this API.

$Horde: gollem/lib/api.php,v 1.14.2.5 2008/10/09 20:54:42 jan Exp $

  • author: Amith Varghese (amith@xalan.com)
  • author: Michael Slusarz (slusarz@curecanti.org)
  • author: Ben Klang (bklang@alkaloid.net)
Functions
Description | Functions
_gollem_browse (line 79)

Browses through the VFS tree.

Each VFS backend is listed as a directory at the top level. No modify operations are allowed outside any VFS area.

  • return: The contents of $path.
  • since: Gollem 1.1
array _gollem_browse ([string $path = ''], [array $properties = array()])
  • string $path: The level of the tree to browse.
  • array $properties: The item properties to return. Defaults to 'name', 'icon', and 'browseable'.
_gollem_getViewLink (line 505)

Returns a link to the gollem file preview interface

  • return: The URL string.
  • since: Gollem 1.1
string _gollem_getViewLink (string $dir, string $file, [string $backend = ''])
  • string $dir: File absolute path
  • string $file: File basename
  • string $backend: Backend key. Defaults to Gollem::getPreferredBackend()
_gollem_mkcol (line 268)

Creates a directory ("collection" in WebDAV-speak) within the VFS

  • return: True on success; PEAR_Error on failure
  • since: Gollem 1.1
mixed _gollem_mkcol (string $path)
  • string $path: Path of directory to create
_gollem_move (line 333)

Renames a file or directory

  • return: True on success; PEAR_Error on failure
  • since: Gollem 1.1
mixed _gollem_move (string $path, string $dest)
  • string $path: Path to source object to be renamed
  • string $dest: Path to new name
_gollem_path_delete (line 411)

Removes a file or folder from the VFS

  • return: True on success; PEAR_Error on failure
  • since: Gollem 1.1
mixed _gollem_path_delete (string $path)
  • string $path: Path of file or folder to delete
_gollem_perms (line 472)
void _gollem_perms ()
_gollem_put (line 205)

Accepts a file for storage into the VFS

  • return: True on success; PEAR_Error on failure
  • since: Gollem 1.1
mixed _gollem_put (string $path, string $content, string $content_type)
  • string $path: Path to store file
  • string $content: Contents of file
  • string $content_type: MIME type of file
_gollem_returnFromSelectlist (line 592)

Returns the data for a given selection ID and index.

  • return: The file data.
string _gollem_returnFromSelectlist (string $selectid, integer $index)
  • string $selectid: The selection ID.
  • integer $index: The index of the file data to return.
_gollem_selectlistLink (line 550)

Creates a link to the gollem file selection window.

The file section window will return a cache ID value which should be used (along with the selectListResults and returnFromSelectList functions below) to obtain the data from a list of selected files.

There MUST be a form field named 'selectlist_selectid' in the calling form. This field will be populated with the selection ID when the user completes file selection.

There MUST be a form parameter named 'actionID' in the calling form. This form will be populated with the value 'selectlist_process' when the user completes file selection. The calling form will be submitted after the window closes (i.e. the calling form must process the 'selectlist_process' actionID).

  • return: The URL string.
string _gollem_selectlistLink (string $link_text, string $link_style, string $formid, [boolean $icon = false], [string $selectid = ''])
  • string $link_text: The text to use in the link.
  • string $link_style: The style to use for the link.
  • string $formid: The formid of the calling script.
  • boolean $icon: Create the link with an icon instead of text?
  • string $selectid: Selection ID.
_gollem_selectlistResults (line 570)

Returns the list of files selected by the user for a given selection ID.

void _gollem_selectlistResults (string $selectid, array 1)
  • string $selectid: The selection ID.
  • array 1: An array with each file entry stored in its own array, with the key as the directory name and the value as the filename.
_gollem_setSelectlist (line 615)

Sets the files selected for a given selection ID.

  • return: The selection ID.
string _gollem_setSelectlist ([string $selectid = ''], [array $files = array()])
  • string $selectid: The selection ID to use.
  • array $files: An array with each file entry stored in its own array, with the key as the directory name and the value as the filename.

Documentation generated on Sun, 30 Jan 2011 05:24:44 +0000 by phpDocumentor 1.4.3