Class Nag_Driver_kolab

Description

Nag driver proxy class for the Kolab IMAP server.

Located in /lib/Driver/kolab.php (line 26)

Nag_Driver
   |
   --Nag_Driver_kolab
Variable Summary
Method Summary
 Nag_Driver_kolab Nag_Driver_kolab (string $tasklist, [array $params = array()])
 void deleteAll ()
 array get (string $taskId)
 array getByUID (string $uid)
 array getChildren (string $parentId)
 boolean initialize ()
 array listAlarms (integer $date)
 mixed retrieve ([integer $completed = 1])
 string _add (string $name, string $desc, [integer $start = 0], [integer $due = 0], [integer $priority = 0], [integer $completed = 0], [float $estimate = 0.0], [string $category = ''], [integer $alarm = 0], [string $uid = null], [string $parent = null], [boolean $private = false], [string $owner = null], [string $assignee = null])
 void _delete (string $taskId)
 boolean _modify (string $taskId, string $name, string $desc, [integer $start = 0], [integer $due = 0], [integer $priority = 0], [float $estimate = 0.0], [integer $completed = 0], [string $category = ''], [integer $alarm = 0], [string $parent = null], [boolean $private = false], [string $owner = null], [string $assignee = null], [integer $completed_date = null])
 void _move (string $taskId, string $newTasklist)
Variables
Kolab $_kolab = null (line 33)

Our Kolab server connection.

Nag_Driver_kolab_wrapper $_wrapper = null (line 40)

The wrapper to decide between the Kolab implementation

Inherited Variables

Inherited from Nag_Driver

Nag_Driver::$tasks
Nag_Driver::$_errormsg
Nag_Driver::$_params
Nag_Driver::$_tasklist
Methods
Constructor Nag_Driver_kolab (line 48)

Constructs a new Kolab storage object.

Nag_Driver_kolab Nag_Driver_kolab (string $tasklist, [array $params = array()])
  • string $tasklist: The tasklist to load.
  • array $params: A hash containing connection parameters.
deleteAll (line 186)

Deletes all tasks from the backend.

void deleteAll ()
get (line 83)

Retrieves one task from the store.

  • return: The array of task attributes.
array get (string $taskId)
  • string $taskId: The id of the task to retrieve.

Redefinition of:
Nag_Driver::get()
Retrieves one task from the database.
getByUID (line 95)

Retrieves one task from the database by UID.

  • return: The array of task attributes.
array getByUID (string $uid)
  • string $uid: The UID of the task to retrieve.

Redefinition of:
Nag_Driver::getByUID()
Retrieves one task from the database by UID.
getChildren (line 230)

Retrieves sub-tasks from the database.

  • return: List of sub-tasks.
array getChildren (string $parentId)
  • string $parentId: The parent id for the sub-tasks to retrieve.

Redefinition of:
Nag_Driver::getChildren()
Retrieves sub-tasks from the database.
initialize (line 71)

Attempts to open a Kolab Groupware folder.

  • return: True on success, PEAR_Error on failure.
boolean initialize ()
listAlarms (line 218)

Lists all alarms near $date.

  • return: An array of tasks that have alarms that match.
array listAlarms (integer $date)
  • integer $date: The unix epoch time to check for alarms.

Redefinition of:
Nag_Driver::listAlarms()
List all alarms near $date.
retrieve (line 199)

Retrieves tasks from the Kolab server.

  • return: True on success, PEAR_Error on failure.
mixed retrieve ([integer $completed = 1])
  • integer $completed: Which tasks to retrieve (1 = all tasks,
    1. = incomplete tasks, 2 = complete tasks).

Redefinition of:
Nag_Driver::retrieve()
Retrieves tasks from the database.
_add (line 120)

Adds a task to the backend storage.

  • return: The Nag ID of the new task.
string _add (string $name, string $desc, [integer $start = 0], [integer $due = 0], [integer $priority = 0], [integer $completed = 0], [float $estimate = 0.0], [string $category = ''], [integer $alarm = 0], [string $uid = null], [string $parent = null], [boolean $private = false], [string $owner = null], [string $assignee = null])
  • string $name: The name (short) of the task.
  • string $desc: The description (long) of the task.
  • integer $start: The start date of the task.
  • integer $due: The due date of the task.
  • integer $priority: The priority of the task.
  • float $estimate: The estimated time to complete the task.
  • integer $completed: The completion state of the task.
  • string $category: The category of the task.
  • integer $alarm: The alarm associated with the task.
  • string $uid: A Unique Identifier for the task.
  • string $parent: The parent task id.
  • boolean $private: Whether the task is private.
  • string $owner: The owner of the event.
  • string $assignee: The assignee of the event.
_delete (line 178)

Deletes a task from the backend.

void _delete (string $taskId)
  • string $taskId: The task to delete.
_modify (line 151)

Modifies an existing task.

  • return: Indicates if the modification was successfull.
boolean _modify (string $taskId, string $name, string $desc, [integer $start = 0], [integer $due = 0], [integer $priority = 0], [float $estimate = 0.0], [integer $completed = 0], [string $category = ''], [integer $alarm = 0], [string $parent = null], [boolean $private = false], [string $owner = null], [string $assignee = null], [integer $completed_date = null])
  • string $taskId: The task to modify.
  • string $name: The name (short) of the task.
  • string $desc: The description (long) of the task.
  • integer $start: The start date of the task.
  • integer $due: The due date of the task.
  • integer $priority: The priority of the task.
  • float $estimate: The estimated time to complete the task.
  • integer $completed: The completion state of the task.
  • string $category: The category of the task.
  • integer $alarm: The alarm associated with the task.
  • string $parent: The parent task id.
  • boolean $private: Whether the task is private.
  • string $owner: The owner of the event.
  • string $assignee: The assignee of the event.
  • integer $completed_date: The task's completion date.
_move (line 168)

Moves a task to a different tasklist.

void _move (string $taskId, string $newTasklist)
  • string $taskId: The task to move.
  • string $newTasklist: The new tasklist.

Inherited Methods

Inherited From Nag_Driver

 Nag_Driver::Nag_Driver()
 Nag_Driver::add()
 Nag_Driver::delete()
 Nag_Driver::factory()
 Nag_Driver::generateUID()
 Nag_Driver::get()
 Nag_Driver::getByUID()
 Nag_Driver::getChildren()
 Nag_Driver::listAlarms()
 Nag_Driver::modify()
 Nag_Driver::retrieve()
 Nag_Driver::singleton()

Documentation generated on Sun, 30 Jan 2011 05:35:03 +0000 by phpDocumentor 1.4.3