Class Nag_Driver_kolab_wrapper_new

Description
Description | Vars (details) | Methods (details)

New Nag driver for the Kolab IMAP server.

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

Nag_Driver_kolab_wrapper
   |
   --Nag_Driver_kolab_wrapper_new
Variable Summary
Description | Vars (details) | Methods (details)
Kolab_IMAP $_store
Method Summary
Description | Vars (details) | Methods (details)
mixed add (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 $uid = null], [string $parent = null], [boolean $private = false], [string $owner = null], [string $assignee = null])
mixed connect ()
void delete (string $taskId)
void deleteAll ()
Nag_Task get (string $taskId)
Nag_Task getByUID (string $uid)
array getChildren (string $parentId)
array listAlarms (integer $date)
mixed 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])
mixed move (string $taskId, string $newTasklist)
mixed retrieve ([integer $completed = 1])
array _buildTask (array $task)
mixed _setObject (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 $uid = null], [string $parent = null], [boolean $private = false], [string $owner = null], [string $assignee = null], [integer $completed_date = null])
array _splitId (string $id)
string _uniqueId (string $id)
Variables
Description | Vars (details) | Methods (details)
Kolab_IMAP $_store = null (line 666)

Shortcut to the imap connection

Inherited Variables

Inherited from Nag_Driver_kolab_wrapper

Nag_Driver_kolab_wrapper::$_connected
 Nag_Driver_kolab_wrapper::$_kolab
 Nag_Driver_kolab_wrapper::$_tasklist
Methods
Description | Vars (details) Methods (details)
add (line 861)

Adds a task to the backend storage.

  • return: The id of the task if successful, a PEAR error otherwise
mixed add (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 $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.
connect (line 673)

Connect to the Kolab backend

  • return: True on success, a PEAR error otherwise
mixed connect ()
Redefinition of:
Nag_Driver_kolab_wrapper::connect()
Connect to the Kolab backend
delete (line 929)

Deletes a task from the backend.

void delete (string $taskId)
  • string $taskId: The task to delete.
deleteAll (line 939)

Deletes all tasks from the backend.

void deleteAll ()
get (line 733)

Retrieves one task from the store.

  • return: A Nag_Task object.
Nag_Task get (string $taskId)
  • string $taskId: The id of the task to retrieve.
getByUID (line 752)

Retrieves one task from the database by UID.

  • return: A Nag_Task object.
Nag_Task getByUID (string $uid)
  • string $uid: The UID of the task to retrieve.
getChildren (line 1080)

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.
listAlarms (line 1049)

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.
modify (line 893)

Modifies an existing task.

  • return: The id of the task if successful, a PEAR error otherwise
mixed 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 917)

Moves a task to a different tasklist.

  • return: True on success, PEAR_Error on failure.
mixed move (string $taskId, string $newTasklist)
  • string $taskId: The task to move.
  • string $newTasklist: The new tasklist.
retrieve (line 954)

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,
    3 = future tasks, 4 = future and incomplete tasks).
_buildTask (line 1014)

Build a task based a data array

  • return: The converted data array representing the task
array _buildTask (array $task)
  • array $task: The data for the task
_setObject (line 787)

Add or modify a task.

  • return: The id of the task if successful, a PEAR error otherwise
mixed _setObject (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 $uid = null], [string $parent = null], [boolean $private = false], [string $owner = null], [string $assignee = null], [integer $completed_date = 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.
  • integer $completed_date: The task's completion date.
_splitId (line 698)

Split the tasklist name of the id. We use this to make ids unique across folders.

  • return: The task id and tasklist name
array _splitId (string $id)
  • string $id: The ID of the task appended with the tasklist name.
_uniqueId (line 718)

Append the tasklist name to the id. We use this to make ids unique across folders.

  • return: The task id appended with the tasklist name.
string _uniqueId (string $id)
  • string $id: The ID of the task

Inherited Methods

Inherited From Nag_Driver_kolab_wrapper

Nag_Driver_kolab_wrapper::Nag_Driver_kolab_wrapper()
Nag_Driver_kolab_wrapper::connect()

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