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.
Methods summary
public
|
|
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
|
public
string
|
#
getTitle( )
Returns a readable title for this folder.
Returns a readable title for this folder.
Returns
string The folder title.
Implementation of
|
public
string
|
#
getNamespace( )
Return the namespace of the folder.
Return the namespace of the folder.
Returns
string The namespace of the folder.
Implementation of
|
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
|
public
string
|
#
getOwner( )
Returns the owner of the folder.
Returns the owner of the folder.
Returns
string The owner of this folder.
Implementation of
|
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
|
public
string
|
#
getParent( )
Returns the folder parent.
Returns the folder parent.
Returns
string The parent of this folder.
Implementation of
|
public
boolean
|
#
isDefault( )
Is this a default folder?
Is this a default folder?
Returns
boolean Boolean that indicates the default status.
Implementation of
|
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
|
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.
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
|
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
|
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
|
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
|
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
|
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
|