The basic list query.
Copyright 2010-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
Methods summary
public
|
|
public
array
|
#
listTypes( )
Returns the folder types as associative array.
Returns the folder types as associative array.
Returns
array The list folder types with the folder names as key and the
type as values.
Implementation of
|
public
array
|
#
listFolderTypeAnnotations( )
Returns the folder type annotation as associative array.
Returns the folder type annotation as associative array.
Returns
array The list folder types with the folder names as key and the
type handler as values.
Implementation of
|
public
array
|
#
listByType( string $type )
List all folders of a specific type.
List all folders of a specific type.
Parameters
- $type
- The folder type the listing should be limited to.
Returns
array The list of folders.
Implementation of
|
public
array
|
#
dataByType( string $type )
List basic folder data for the folders of a specific type.
List basic folder data for the folders of a specific type.
Parameters
- $type
- The folder type the listing should be limited to.
Returns
array The list of folders.
Implementation of
|
public
array
|
#
folderData( string $folder )
List basic folder data for the specified folder.
List basic folder data for the specified folder.
Parameters
Returns
array The folder data.
Implementation of
|
public
array
|
#
listOwners( )
Get the folder owners.
Returns
array The folder owners with the folder names as key and the
owner as values.
Implementation of
|
public
array
|
#
listPersonalDefaults( )
Return the list of personal default folders.
Return the list of personal default folders.
Returns
array An array that associates type (key) with the corresponding
default folder name (value).
|
public
array
|
#
listDefaults( )
Return the list of default folders.
Return the list of default folders.
Returns
array An array with owners as keys and another array as
value. The second array associates type (key) with the
corresponding default folder (value).
Implementation of
|
public
string|boolean
|
#
getDefault( string $type )
Get the default folder for a certain type.
Get the default folder for a certain type.
Parameters
- $type
- The type of the share/folder.
Returns
string|boolean The name of the default folder, false if there is no default.
Implementation of
|
public
string|boolean
|
#
getForeignDefault( string $owner, string $type )
Get the default folder for a certain type from a different owner.
Get the default folder for a certain type from a different owner.
Parameters
- $owner
- The folder owner.
- $type
- The type of the share/folder.
Returns
string|boolean The name of the default folder, false if there is no default.
Implementation of
|
public
null
|
#
createFolder( string $folder, string $type = null )
Create a new folder.
Parameters
- $folder
- The path of the folder to create.
- $type
- An optional type for the folder.
Returns
null
Implementation of
|
public
null
|
#
deleteFolder( string $folder )
Delete a folder.
Parameters
- $folder
- The path of the folder to delete.
Returns
null
Implementation of
|
public
null
|
#
renameFolder( string $old, string $new )
Rename a folder.
Parameters
- $old
- The old path of the folder.
- $new
- The new path of the folder.
Returns
null
Implementation of
|
public
string
|
#
getStamp( )
Return the last sync stamp.
Return the last sync stamp.
Returns
string The stamp.
Implementation of
|
public
null
|
#
synchronize( array $params = array() )
Synchronize the query data with the information from the backend.
Synchronize the query data with the information from the backend.
Parameters
- $params
- Additional parameters.
Returns
null
Implementation of
|