PHP Class Horde_Kolab_Storage_List_Query_List_Cache, horde

See link: http://pear.horde.org/index.php?package=Kolab_Storage

Author: Gunnar Wrobel ([email protected])

Inheritance: extends Horde_Kolab_Storage_List_Query_List, implements Horde_Kolab_Storage_List_Manipulation_Listener, implements Horde_Kolab_Storage_List_Synchronization_Listener

Datei anzeigen Open project: horde/horde

Public Methods

Method	Description
__construct ( Horde_Kolab_Storage_List_Query_List_Cache_Synchronization $sync, Horde_Kolab_Storage_List_Cache $cache )	Constructor.
dataByType ( string $type ) : array	List basic folder data for the folders of a specific type.
folderData ( string $folder ) : array	List basic folder data for the specified folder.
getDefault ( string $type ) : string \| boolean	Get the default folder for a certain type.
getDuplicateDefaults ( ) : array	Return any default folder duplicates.
getForeignDefault ( string $owner, string $type ) : string \| boolean	Get the default folder for a certain type from a different owner.
getStamp ( ) : string	Return the last sync stamp.
listByType ( string $type ) : array	List all folders of a specific type.
listDefaults ( ) : array	Return the list of default folders.
listOwners ( ) : array	Get the folder owners.
listPersonalDefaults ( ) : array	Return the list of personal default folders.
listTypes ( ) : array	Returns the folder types as associative array.
setDefault ( string $folder )	Set the specified folder as default for its current type.
synchronize ( )	Synchronize the listener.
updateAfterCreateFolder ( string $folder, string $type = null ) : null	Update the listener after creating a new folder.
updateAfterDeleteFolder ( string $folder ) : null	Update the listener after deleting folder.
updateAfterRenameFolder ( string $old, string $new ) : null	Update the listener after renaming a folder.

Private Methods

Method	Description
_initQuery ( string $query ) : null	Ensure we have the query data.

Method Details

__construct() public method

Constructor.

public __construct ( Horde_Kolab_Storage_List_Query_List_Cache_Synchronization $sync, Horde_Kolab_Storage_List_Cache $cache )
$sync	Horde_Kolab_Storage_List_Query_List_Cache_Synchronization	The synchronization handler..
$cache	Horde_Kolab_Storage_List_Cache	The list cache.

dataByType() public method

List basic folder data for the folders of a specific type.

public dataByType ( string $type ) : array
$type	string	The folder type the listing should be limited to.
return	array	The list of folders.

folderData() public method

List basic folder data for the specified folder.

public folderData ( string $folder ) : array
$folder	string	The folder path.
return	array	The folder data.

getDefault() public method

Get the default folder for a certain type.

public getDefault ( string $type ) : string \| boolean
$type	string	The type of the share/folder.
return	string \| boolean	The name of the default folder, false if there is no default.

getDuplicateDefaults() public method

Return any default folder duplicates.

public getDuplicateDefaults ( ) : array
return	array	The list of duplicate default folders accessible to the current user.

getForeignDefault() public method

Get the default folder for a certain type from a different owner.

public getForeignDefault ( string $owner, string $type ) : string \| boolean
$owner	string	The folder owner.
$type	string	The type of the share/folder.
return	string \| boolean	The name of the default folder, false if there is no default.

getStamp() public method

Return the last sync stamp.

public getStamp ( ) : string
return	string	The stamp.

listByType() public method

List all folders of a specific type.

public listByType ( string $type ) : array
$type	string	The folder type the listing should be limited to.
return	array	The list of folders.

listDefaults() public method

Return the list of default folders.

public listDefaults ( ) : array
return	array	An array with owners as keys and another array as value. The second array associates type (key) with the corresponding default folder (value).

listOwners() public method

Get the folder owners.

public listOwners ( ) : array
return	array	The folder owners with the folder names as key and the owner as values.

listPersonalDefaults() public method

Return the list of personal default folders.

public listPersonalDefaults ( ) : array
return	array	An array that associates type (key) with the corresponding default folder name (value).

listTypes() public method

Returns the folder types as associative array.

public listTypes ( ) : array
return	array	The list folder types with the folder names as key and the type as values.

setDefault() public method

Set the specified folder as default for its current type.

public setDefault ( string $folder )
$folder	string	The folder name.

synchronize() public method

Synchronize the listener.

public synchronize ( )

updateAfterCreateFolder() public method

Update the listener after creating a new folder.

public updateAfterCreateFolder ( string $folder, string $type = null ) : null
$folder	string	The path of the folder that has been created.
$type	string	An optional type for the folder.
return	null

updateAfterDeleteFolder() public method

Update the listener after deleting folder.

public updateAfterDeleteFolder ( string $folder ) : null
$folder	string	The path of the folder that has been deleted.
return	null

updateAfterRenameFolder() public method

Update the listener after renaming a folder.

public updateAfterRenameFolder ( string $old, string $new ) : null
$old	string	The old path of the folder.
$new	string	The new path of the folder.
return	null