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_Folder_Decorator_Base

The basic decorator definition for Kolab folders.

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.

Horde_Kolab_Storage_Folder_Decorator_Base implements Horde_Kolab_Storage_Folder

Direct known subclasses

Horde_Kolab_Storage_Folder_Decorator_Trigger
Package: Kolab\Storage
Author: Gunnar Wrobel wrobel@pardus.de
Located at Horde/Kolab/Storage/Folder/Decorator/Base.php
Methods summary
public
# __construct( Horde_Kolab_Storage_Folder $folder )

Constructor

Constructor

Parameters

$folder
The folder to be decorated.
public string
# getPath( )

Return the storage path of the folder.

Return the storage path of the folder.

Returns

string
The storage path of the folder.

Implementation of

Horde_Kolab_Storage_Folder::getPath()
public string
# getTitle( )

Returns a readable title for this folder.

Returns a readable title for this folder.

Returns

string
The folder title.

Implementation of

Horde_Kolab_Storage_Folder::getTitle()
public string
# getNamespace( )

Return the namespace of the folder.

Return the namespace of the folder.

Returns

string
The namespace of the folder.

Implementation of

Horde_Kolab_Storage_Folder::getNamespace()
public string
# getPrefix( )

Return the namespace prefix of the folder.

Return the namespace prefix of the folder.

Returns

string
The namespace prefix of the folder.

Since

Horde_Kolab_Storage 1.1.0

Implementation of

Horde_Kolab_Storage_Folder::getPrefix()
public string
# getOwner( )

Returns the owner of the folder.

Returns the owner of the folder.

Returns

string
The owner of this folder.

Implementation of

Horde_Kolab_Storage_Folder::getOwner()
public string
# getSubpath( )

Returns the folder path without namespace components.

Returns the folder path without namespace components.

Returns

string
The subpath of this folder.

Implementation of

Horde_Kolab_Storage_Folder::getSubpath()
public string
# getParent( )

Returns the folder parent.

Returns the folder parent.

Returns

string
The parent of this folder.

Implementation of

Horde_Kolab_Storage_Folder::getParent()
public boolean
# isDefault( )

Is this a default folder?

Is this a default folder?

Returns

boolean
Boolean that indicates the default status.

Implementation of

Horde_Kolab_Storage_Folder::isDefault()
public
# setPath( string $path )

Set a new storage path for the folder. The new path will be realized when saving the folder.

Set a new storage path for the folder. The new path will be realized when saving the folder.

Parameters

$path
The new folder path.
public null
# setTitle( string $title )

Set a new title for the folder. The new title will be realized when saving the folder.

Set a new title for the folder. The new title will be realized when saving the folder.

Parameters

$title
The new folder title.

Returns

null
public null
# setTitleInOther( string $title, string $owner )

Set a new title for the folder and assign it to the namespace of other users. The new title will be realized when saving the folder.

Set a new title for the folder and assign it to the namespace of other users. The new title will be realized when saving the folder.

Parameters

$title
The new folder title.
$owner
The new owner of the folder.

Returns

null
public null
# setTitleInShared( string $title )

Set a new title for the folder and assign it to the shared namespace. The new title will be realized when saving the folder.

Set a new title for the folder and assign it to the shared namespace. The new title will be realized when saving the folder.

Parameters

$title
The new folder title.

Returns

null
public Horde_Kolab_Storage_Driver
# getDriver( )

Retrieve the driver for this folder.

Retrieve the driver for this folder.

Returns

Horde_Kolab_Storage_Driver
The folder driver.
public Horde_Kolab_Storage_Folder_Permission
# getPermission( )

Get the permissions for this folder.

Get the permissions for this folder.

Returns

Horde_Kolab_Storage_Folder_Permission
The permission handler.
public null
# setPermission( Horde_Kolab_Storage_Folder_Permission $perms, boolean $update = true )

Sets the permissions on this folder.

Sets the permissions on this folder.

Parameters

$perms
Permission object.
$update
<p>Save the updated information?</p>

Returns

null
public null
# save( array $attributes = null )

Saves the folder.

Saves the folder.

Parameters

$attributes
<p>An array of folder attributes. You can set any attribute but there are a few special ones like 'type', 'default', 'owner' and 'desc'.</p>

Returns

null

Implementation of

Horde_Kolab_Storage_Folder::save()
public null
# deleteMessage( string $id, boolean $trigger = true )

Delete the specified message from this folder.

Delete the specified message from this folder.

Parameters

$id
IMAP id of the message to be deleted.
$trigger
Should the folder be triggered?

Returns

null

Implementation of

Horde_Kolab_Storage_Folder::deleteMessage()
public boolean
# moveMessage( string $id, string $folder )

Move the specified message to the specified folder.

Move the specified message to the specified folder.

Parameters

$id
IMAP id of the message to be moved.
$folder
Name of the receiving folder.

Returns

boolean
True if successful.

Implementation of

Horde_Kolab_Storage_Folder::moveMessage()
public null
# moveMessageToShare( string $id, string $share )

Move the specified message to the specified share.

Move the specified message to the specified share.

Parameters

$id
IMAP id of the message to be moved.
$share
Name of the receiving share.

Returns

null

Implementation of

Horde_Kolab_Storage_Folder::moveMessageToShare()
public boolean
# saveObject( array & $object, integer $data_version, string $object_type, string $id = null, array & $old_object = null )

Save an object in this folder.

Save an object in this folder.

Parameters

$object
The array that holds the data of the object.
$data_version
The format handler version.
$object_type
The type of the kolab object.
$id
<p>The IMAP id of the old object if it existed before</p>
$old_object
<p>The array that holds the current data of the object.</p>

Returns

boolean
True on success.

Implementation of

Horde_Kolab_Storage_Folder::saveObject()
public array
# getAcl( )

Return the IMAP ACL of this folder.

Return the IMAP ACL of this folder.

Returns

array
An array with IMAP ACL.
public null
# setAcl( mixed $user, mixed $acl )

Set the ACL of this folder.

Set the ACL of this folder.

Parameters

$user
user for whom the ACL should be set.
$acl
new ACL value.

Returns

null
public null
# deleteAcl( mixed $user )

Delete the ACL for a user on this folder.

Delete the ACL for a user on this folder.

Parameters

$user
user for whom the ACL should be deleted.

Returns

null
API documentation generated by ApiGen