Overview

Packages

  • Kolab
    • Storage

Classes

  • Horde_Kolab_Storage_Base
  • Horde_Kolab_Storage_Cache
  • Horde_Kolab_Storage_Cache_Data
  • Horde_Kolab_Storage_Cache_List
  • Horde_Kolab_Storage_Cached
  • Horde_Kolab_Storage_Data_Base
  • Horde_Kolab_Storage_Data_Cached
  • Horde_Kolab_Storage_Data_Decorator_Log
  • Horde_Kolab_Storage_Data_Format_Mime
  • Horde_Kolab_Storage_Data_Modifiable
  • Horde_Kolab_Storage_Data_Old
  • Horde_Kolab_Storage_Data_Parser_Structure
  • Horde_Kolab_Storage_Data_Query_History_Base
  • Horde_Kolab_Storage_Data_Query_History_Cache
  • Horde_Kolab_Storage_Data_Query_Preferences_Base
  • Horde_Kolab_Storage_Data_Query_Preferences_Cache
  • Horde_Kolab_Storage_Decorator_Synchronization
  • Horde_Kolab_Storage_Driver_Base
  • Horde_Kolab_Storage_Driver_Cclient
  • Horde_Kolab_Storage_Driver_Decorator_Base
  • Horde_Kolab_Storage_Driver_Decorator_Log
  • Horde_Kolab_Storage_Driver_Decorator_Timer
  • Horde_Kolab_Storage_Driver_Imap
  • Horde_Kolab_Storage_Driver_Mock
  • Horde_Kolab_Storage_Driver_Mock_Data
  • Horde_Kolab_Storage_Driver_Pear
  • Horde_Kolab_Storage_Driver_Rcube
  • Horde_Kolab_Storage_Exception
  • Horde_Kolab_Storage_Exception_Pear
  • Horde_Kolab_Storage_Factory
  • Horde_Kolab_Storage_Folder_Base
  • Horde_Kolab_Storage_Folder_Decorator_Base
  • Horde_Kolab_Storage_Folder_Decorator_Trigger
  • Horde_Kolab_Storage_Folder_Namespace
  • Horde_Kolab_Storage_Folder_Namespace_Config
  • Horde_Kolab_Storage_Folder_Namespace_Element
  • Horde_Kolab_Storage_Folder_Namespace_Element_Other
  • Horde_Kolab_Storage_Folder_Namespace_Element_Personal
  • Horde_Kolab_Storage_Folder_Namespace_Element_Shared
  • Horde_Kolab_Storage_Folder_Namespace_Element_SharedWithPrefix
  • Horde_Kolab_Storage_Folder_Namespace_Fixed
  • Horde_Kolab_Storage_Folder_Namespace_Imap
  • Horde_Kolab_Storage_Folder_Stamp_Uids
  • Horde_Kolab_Storage_Folder_Type
  • Horde_Kolab_Storage_List_Base
  • Horde_Kolab_Storage_List_Decorator_Cache
  • Horde_Kolab_Storage_List_Decorator_Log
  • Horde_Kolab_Storage_List_Query_Acl_Base
  • Horde_Kolab_Storage_List_Query_Acl_Cache
  • Horde_Kolab_Storage_List_Query_ActiveSync_Base
  • Horde_Kolab_Storage_List_Query_ActiveSync_Cache
  • Horde_Kolab_Storage_List_Query_List_Base
  • Horde_Kolab_Storage_List_Query_List_Cache
  • Horde_Kolab_Storage_List_Query_Share_Base
  • Horde_Kolab_Storage_List_Query_Share_Cache
  • Horde_Kolab_Storage_QuerySet_Base
  • Horde_Kolab_Storage_QuerySet_Cached
  • Horde_Kolab_Storage_QuerySet_Uncached
  • Horde_Kolab_Storage_Synchronization
  • Horde_Kolab_Storage_Translation
  • Horde_Kolab_Storage_Uncached

Interfaces

  • Horde_Kolab_Storage
  • Horde_Kolab_Storage_Data
  • Horde_Kolab_Storage_Data_Format
  • Horde_Kolab_Storage_Data_Parser
  • Horde_Kolab_Storage_Data_Query
  • Horde_Kolab_Storage_Data_Query_History
  • Horde_Kolab_Storage_Data_Query_Preferences
  • Horde_Kolab_Storage_Driver
  • Horde_Kolab_Storage_Folder
  • Horde_Kolab_Storage_Folder_Stamp
  • Horde_Kolab_Storage_List
  • Horde_Kolab_Storage_List_Query
  • Horde_Kolab_Storage_List_Query_Acl
  • Horde_Kolab_Storage_List_Query_ActiveSync
  • Horde_Kolab_Storage_List_Query_List
  • Horde_Kolab_Storage_List_Query_Share
  • Horde_Kolab_Storage_Queriable
  • Horde_Kolab_Storage_Query
  • Horde_Kolab_Storage_QuerySet
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Kolab_Storage_List_Query_Share_Base

Handles a share parameters.

Copyright 2011-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.

Horde_Kolab_Storage_List_Query_Share_Base implements Horde_Kolab_Storage_List_Query_Share

Direct known subclasses

Horde_Kolab_Storage_List_Query_Share_Cache
Package: Kolab\Storage
Category: Kolab
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Storage
Located at Horde/Kolab/Storage/List/Query/Share/Base.php
Methods summary
public
# __construct( Horde_Kolab_Storage_List $list, array $params )

Constructor.

Constructor.

Parameters

$list
The queriable list.
$params
Additional parameters.
public string
# getDescription( string $folder )

Returns the share description.

Returns the share description.

Parameters

$folder
The folder name.

Returns

string
The folder/share description.

Implementation of

Horde_Kolab_Storage_List_Query_Share::getDescription()
public string
# getParameters( string $folder )

Returns the share parameters.

Returns the share parameters.

Parameters

$folder
The folder name.

Returns

string
The folder/share parameters.

Implementation of

Horde_Kolab_Storage_List_Query_Share::getParameters()
public null
# setDescription( string $folder, string $description )

Set the share description.

Set the share description.

Parameters

$folder
The folder name.
$description
The share description.

Returns

null

Implementation of

Horde_Kolab_Storage_List_Query_Share::setDescription()
public string
# setParameters( string $folder, array $parameters )

Set the share parameters.

Set the share parameters.

Parameters

$folder
The folder name.
$parameters
The share parameters.

Returns

string
The encoded share parameters.

Implementation of

Horde_Kolab_Storage_List_Query_Share::setParameters()
public null
# createFolder( string $folder, string $type = null )

Create a new folder.

Create a new folder.

Parameters

$folder
The path of the folder to create.
$type
An optional type for the folder.

Returns

null

Implementation of

Horde_Kolab_Storage_List_Query::createFolder()
public null
# deleteFolder( string $folder )

Delete a folder.

Delete a folder.

Parameters

$folder
The path of the folder to delete.

Returns

null

Implementation of

Horde_Kolab_Storage_List_Query::deleteFolder()
public null
# renameFolder( string $old, string $new )

Rename a folder.

Rename a folder.

Parameters

$old
The old path of the folder.
$new
The new path of the folder.

Returns

null

Implementation of

Horde_Kolab_Storage_List_Query::renameFolder()
public string
# getStamp( )

Return the last sync stamp.

Return the last sync stamp.

Returns

string
The stamp.

Implementation of

Horde_Kolab_Storage_List_Query::getStamp()
public null
# synchronize( array $params = array() )

Synchronize the ACL information with the information from the backend.

Synchronize the ACL information with the information from the backend.

Parameters

$params
Additional parameters.

Returns

null

Implementation of

Horde_Kolab_Storage_Query::synchronize()
Constants summary
string ANNOTATION_DESCRIPTION

The folder description

The folder description
# '/shared/comment'
string ANNOTATION_SHARE_PARAMETERS
# '/shared/vendor/horde/share-params'
API documentation generated by ApiGen