Class Nag_Driver_kolab_wrapper_old

Description
Description | Vars | Methods (details)

Old Nag driver for the Kolab IMAP server.

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

Nag_Driver_kolab_wrapper
   |
   --Nag_Driver_kolab_wrapper_old
Method Summary
Description | Vars | Methods (details)
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)
void deleteAll ()
array get (string $taskId)
array getByUID (string $uid)
array getChildren (string $parentId)
array listAlarms (integer $date)
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)
mixed retrieve ([integer $completed = 1])
void _buildTask ()
string _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 $parent = null], [boolean $private = false], [string $owner = null], [string $assignee = null], [integer $completed_date = null])
Variables
Description | Vars (details) | Methods (details)

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 Methods (details)
add (line 438)

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 519)

Deletes a task from the backend.

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

Deletes all tasks from the backend.

void deleteAll ()
get (line 342)

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.
getByUID (line 359)

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.
getChildren (line 618)

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 582)

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 480)

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 509)

Moves a task to a different tasklist.

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

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 312)
void _buildTask ()
_setObject (line 385)
  • return: The ID of the task.
  • todo: Utilize $owner, $assignee, and $completed_date parameters.
string _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 $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 $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.

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