| Property | Type | Description | |
|---|---|---|---|
| $_data | Horde_Kolab_Storage_Data | The current tasklist. | |
| $_kolab | Horde_Kolab_Storage | The Kolab_Storage backend. |
| Method | Description | |
|---|---|---|
| __construct ( string $tasklist, array $params = [] ) | Constructs a new Kolab storage object. | |
| _isBase64EncodedUid ( string $s ) : boolean | Detect if a string is already Horde_Url::uriB64Encode()'ed or not. | |
| get ( string $taskId ) : Nag_Task | Retrieves one task from the backend. | |
| getByUID ( string $uid, array $tasklists = null, boolean $getall = true ) : Nag_Task | Retrieves one task from the database by UID. | |
| getChildren ( string $parentId, boolean $include_history = true ) : array | Retrieves sub-tasks from the database. | |
| listAlarms ( integer $date ) : array | Lists all alarms near $date. | |
| open ( string $tasklist ) | Sets the currently open tasklist. | |
| retrieve ( integer $completed = Nag::VIEW_ALL ) | Retrieves tasks from the Kolab server. | |
| synchronize ( mixed $token = false ) | Synchronize with the Kolab backend. |
| Method | Description | |
|---|---|---|
| _add ( array $task ) : string | Adds a task to the backend storage. | |
| _buildTask ( array $task ) : array | Build a task based a data array | |
| _delete ( string $taskId ) | Deletes a task from the backend. | |
| _deleteAll ( ) : array | Deletes all tasks from the backend. | |
| _getData ( boolean $force = false ) : Horde_Kolab_Storage_Data | Return the Kolab data handler for the current tasklist. | |
| _getDataForTasklist ( string $tasklist ) : Horde_Kolab_Storage_Date | Return the Kolab data handler for the specified tasklist. | |
| _getObject ( array $task ) : array | Retrieve the Kolab object representations for the task. | |
| _modify ( string $taskId, array $task ) | Modifies an existing task. | |
| _move ( string $taskId, string $newTasklist ) | Moves a task to a different tasklist. |
| public __construct ( string $tasklist, array $params = [] ) | ||
| $tasklist | string | The tasklist to load. |
| $params | array | A hash containing connection parameters. |
| protected _add ( array $task ) : string | ||
| $task | array | A hash with the following possible properties: - alarm: (integer) The alarm associated with the task. - assignee: (string) The assignee of the event. - completed: (integer) The completion state of the task. - desc: (string) The description (long) of the task. - due: (integer) The due date of the task. - estimate: (float) The estimated time to complete the task. - methods: (array) The overridden alarm notification methods. - name: (string) The name (short) of the task. - organizer: (string) The organizer/owner of the task. - owner: (string) The owner of the event. - parent: (string) The parent task. - priority: (integer) The priority of the task. - private: (boolean) Whether the task is private. - recurrence: (Horde_Date_Recurrence|array) Recurrence information. - start: (integer) The start date of the task. - tags: (array) The task tags. - uid: (string) A Unique Identifier for the task. |
| return | string | The Nag ID of the new task. |
| protected _buildTask ( array $task ) : array | ||
| $task | array | The data for the task |
| return | array | The converted data array representing the task |
| protected _deleteAll ( ) : array | ||
| return | array | An array of ids that have been deleted. |
| protected _getDataForTasklist ( string $tasklist ) : Horde_Kolab_Storage_Date | ||
| $tasklist | string | The tasklist name. |
| return | Horde_Kolab_Storage_Date | The data handler. |
| protected _getObject ( array $task ) : array | ||
| $task | array | A hash with the following possible properties: - actual: (float) The actual number of hours accumulated. - alarm: (integer) The alarm associated with the task. - assignee: (string) The assignee of the event. - completed: (integer) The completion state of the task. - completed_date: (integer) The task's completion date. - desc: (string) The description (long) of the task. - due: (integer) The due date of the task. - estimate: (float) The estimated time to complete the task. - methods: (array) The overridden alarm notification methods. - name: (string) The name (short) of the task. - organizer: (string) The organizer/owner of the task. - owner: (string) The owner of the event. - parent: (string) The parent task. - priority: (integer) The priority of the task. - private: (boolean) Whether the task is private. - recurrence: (Horde_Date_Recurrence|array) Recurrence information. - start: (integer) The start date of the task. - tags: (array) The task tags. |
| return | array | The Kolab object. |
| public _isBase64EncodedUid ( string $s ) : boolean | ||
| $s | string | The string to test. |
| return | boolean | True if $s was base64 encoded. |
| public getByUID ( string $uid, array $tasklists = null, boolean $getall = true ) : Nag_Task | ||
| $uid | string | The UID of the task to retrieve. |
| $tasklists | array | An optional array of tasklists to search. |
| $getall | boolean | If true, return all instances of the task, otherwise only one. Attempts to find the instance owned by the current user. |
| return | Nag_Task | A Nag_Task object. |
| public listAlarms ( integer $date ) : array | ||
| $date | integer | The unix epoch time to check for alarms. |
| return | array | An array of Nag_Task objects that have alarms that match. |
| public synchronize ( mixed $token = false ) | ||
| $token | mixed | A value indicating the last synchronization point, if available. |
| protected Horde_Kolab_Storage_Data $_data | ||
| return | Horde_Kolab_Storage_Data | |