Class Kolab_List

Description

The Kolab_List class represents all IMAP folders on the Kolab server visible to the current user.

$Horde: framework/Kolab_Storage/lib/Horde/Kolab/Storage/List.php,v 1.3.2.10 2010/06/25 04:53:49 wrobel Exp $

Copyright 2007-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Kolab_Storage/lib/Horde/Kolab/Storage/List.php (line 35)


	
			
Variable Summary
Method Summary
 static Kolab_Folders_List &singleton ([ $destruct = false])
 Kolab_List Kolab_List ()
 boolean|PEAR_Error create ( &$folder, Kolab_Folder $folder)
 Kolab_Folder|PEAR_Error getByShare (string $share, string $type)
 Kolab_Folder|PEAR_Error getByType (string $type)
 mixed getDefault (string $type)
 Kolab_Folder|PEAR_Error getFolder (string $folder)
 array|PEAR_Error getFolders ([array $folders = null])
 mixed getForeignDefault (string $owner, string $type)
 Kolab_Folder|PEAR_Error getNewFolder ()
 void initiateCache ()
 array|PEAR_Error &listFolders ()
 string|PEAR_Error parseShare (string $share, string $type)
 boolean|PEAR_Error remove ( &$folder, Kolab_Folder $folder)
 boolean|PEAR_Error rename ( &$folder, Kolab_Folder $folder)
 void shutdown ()
 void updateCache ( &$folder, [boolean $added = true], Kolab_Folder $folder)
 void __wakeup ()
Variables
Horde_Kolab_Storage_Namespace $namespace (line 77)

The namespace handler.

int $validity (line 70)

A validity marker.

array $_defaults (line 56)

A cache array listing a default folder for each folder type.

array $_folders (line 49)

A cache for folder objects (these do not necessarily exist).

array $_list (line 42)

The list of existing folders on this server.

array $_types (line 63)

A cache array listing a the folders for each folder type.

Methods
static singleton (line 123)

Attempts to return a reference to a concrete Kolab_Folders_List instance.

It will only create a new instance if no Kolab_Folders instance currently exists.

This method must be invoked as:

  1. $var &Kolab_Folders_List::singleton();

  • return: The concrete List reference.
static Kolab_Folders_List &singleton ([ $destruct = false])
  • $destruct
Constructor Kolab_List (line 83)

Constructor.

Kolab_List Kolab_List ()
create (line 386)

Creates a new IMAP folder.

  • return: True on success.
boolean|PEAR_Error create ( &$folder, Kolab_Folder $folder)
  • Kolab_Folder $folder: The folder that should be created.
  • &$folder
getByShare (line 241)

Get a Folder object based on a share ID.

  • return: The Kolab folder object.
Kolab_Folder|PEAR_Error getByShare (string $share, string $type)
  • string $share: The share ID.
  • string $type: The type of the share/folder.
getByType (line 258)

Get a list of folders based on the type.

  • return: The list of Kolab folder objects.
Kolab_Folder|PEAR_Error getByType (string $type)
  • string $type: The type of the share/folder.
getDefault (line 281)

Get the default folder for a certain type.

  • return: The default folder, false if there is no default and a PEAR_Error in case of an error.
mixed getDefault (string $type)
  • string $type: The type of the share/folder.
getFolder (line 211)

Get a Folder object.

  • return: The Kolab folder object.
Kolab_Folder|PEAR_Error getFolder (string $folder)
  • string $folder: The folder name.
getFolders (line 188)

Get several or all Folder objects.

  • return: An array of Kolab_Folder objects.
array|PEAR_Error getFolders ([array $folders = null])
  • array $folders: Several folder names or unset to retrieve all folders.
getForeignDefault (line 305)

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

  • return: The default folder, false if there is no default and a PEAR_Error in case of an error.
mixed getForeignDefault (string $owner, string $type)
  • string $owner: The folder owner.
  • string $type: The type of the share/folder.
getNewFolder (line 226)

Get a new Folder object.

  • return: The new Kolab folder object.
Kolab_Folder|PEAR_Error getNewFolder ()
initiateCache (line 323)

Start the cache for the type specific and the default folders.

void initiateCache ()
listFolders (line 161)

Returns the list of folders visible to the current user.

  • return: The list of IMAP folders, represented as Kolab_Folder objects.
array|PEAR_Error &listFolders ()
parseShare (line 364)

Converts the horde syntax for shares to storage identifiers.

  • return: The corrected folder name.
string|PEAR_Error parseShare (string $share, string $type)
  • string $share: The share ID that should be parsed.
  • string $type: The type of the share/folder.
remove (line 454)

Delete an IMAP folder.

  • return: True on success.
boolean|PEAR_Error remove ( &$folder, Kolab_Folder $folder)
  • Kolab_Folder $folder: The folder that should be deleted.
  • &$folder
rename (line 419)

Rename an IMAP folder.

  • return: True on success.
boolean|PEAR_Error rename ( &$folder, Kolab_Folder $folder)
  • Kolab_Folder $folder: The folder that should be renamed.
  • &$folder
shutdown (line 148)

Stores the object in the session cache.

void shutdown ()
updateCache (line 484)

Update the cache variables.

void updateCache ( &$folder, [boolean $added = true], Kolab_Folder $folder)
  • Kolab_Folder $folder: The folder that was changed.
  • boolean $added: Has the folder been added or removed?
  • &$folder
__wakeup (line 99)

Initializes the object.

void __wakeup ()

Documentation generated on Sun, 30 Jan 2011 05:19:15 +0000 by phpDocumentor 1.4.3