Overview

Packages

  • Nag
  • None

Classes

  • Horde_Core_Ui_VarRenderer_Nag
  • Nag
  • Nag_Ajax_Application
  • Nag_Api
  • Nag_Driver
  • Nag_Driver_Kolab
  • Nag_Driver_Sql
  • Nag_Exception
  • Nag_Factory_Tasklists
  • Nag_Form_CreateTaskList
  • Nag_Form_DeleteTaskList
  • Nag_Form_EditTaskList
  • Nag_Form_Renderer_Task
  • Nag_Form_Task
  • Nag_Form_Type_NagAlarm
  • Nag_Form_Type_NagDue
  • Nag_Form_Type_NagMethod
  • Nag_Form_Type_NagStart
  • Nag_Task
  • Nag_Tasklists_Base
  • Nag_Tasklists_Default
  • Nag_Tasklists_Kolab
  • Overview
  • Package
  • Class
  • Tree

Class Nag_Driver_Kolab

Nag driver classes for the Kolab IMAP server.

Copyright 2004-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Nag_Driver
Extended by Nag_Driver_Kolab
Package: Nag
Author: Gunnar Wrobel wrobel@pardus.de
Author: Thomas Jarosch thomas.jarosch@intra2net.com
Author: Stuart Binge omicron@mighty.co.za
Located at Driver/Kolab.php
Methods summary
public Nag_Driver
# __construct( string $tasklist, array $params = array() )

Constructs a new Kolab storage object.

Constructs a new Kolab storage object.

Parameters

$tasklist
The tasklist to load.
$params
A hash containing connection parameters.

Returns

Nag_Driver

Overrides

Nag_Driver::__construct()
public Nag_Task
# get( string $taskId )

Retrieves one task from the backend.

Retrieves one task from the backend.

Parameters

$taskId
The id of the task to retrieve.

Returns

Nag_Task
A Nag_Task object.

Throws

Horde_Exception_NotFound
Nag_Exception

Overrides

Nag_Driver::get()
public array
# _buildTask( array $task )

Build a task based a data array

Build a task based a data array

Parameters

$task
The data for the task

Returns

array
The converted data array representing the task
public array
# getByUID( string $uid )

Retrieves one task from the database by UID.

Retrieves one task from the database by UID.

Parameters

$uid
The UID of the task to retrieve.

Returns

array
The array of task attributes.

Throws

Nag_Exception

Overrides

Nag_Driver::getByUID()
public
# deleteAll( )

Deletes all tasks from the backend.

Deletes all tasks from the backend.

public mixed
# retrieve( integer $completed = Nag::VIEW_ALL )

Retrieves tasks from the Kolab server.

Retrieves tasks from the Kolab server.

Parameters

$completed
<p>Which tasks to retrieve (1 = all tasks, 0 = incomplete tasks, 2 = complete tasks).</p>

Returns

mixed
True on success, PEAR_Error on failure.

Throws

Nag_Exception

Overrides

Nag_Driver::retrieve()
public array
# listAlarms( integer $date )

Lists all alarms near $date.

Lists all alarms near $date.

Parameters

$date
The unix epoch time to check for alarms.

Returns

array
An array of tasks that have alarms that match.

Overrides

Nag_Driver::listAlarms()
public array
# getChildren( string $parentId )

Retrieves sub-tasks from the database.

Retrieves sub-tasks from the database.

Parameters

$parentId
The parent id for the sub-tasks to retrieve.

Returns

array
List of sub-tasks.

Throws

Nag_Exception

Overrides

Nag_Driver::getChildren()
Methods inherited from Nag_Driver
add(), delete(), factory(), modify(), singleton()
Properties inherited from Nag_Driver
$tasks
API documentation generated by ApiGen