Documentation

Nag_Task

in package

• Nag

Nag_Task handles as single task as well as a list of tasks and implements a recursive iterator to handle a (hierarchical) list of tasks.

Tags

author

Jan Schneider jan@horde.org

Table of Contents

$  : tags

$actual  : float

The actual task length.

$alarm  : int

The task alarm threshold in minutes.

$assignee  : string

The task assignee.

$children  : array<string|int, mixed>

The sub-tasks.

$complete_link  : string

URL to complete the task.

$completed  : bool

Whether the task is completed.

$completed_date  : int

The completion date timestamp.

$created  : Horde_Date

The creation time.

$createdby  : string

The creator string.

$delete_link  : string

URL to delete the task.

$desc  : string

The task decription.

$due  : int

The due date timestamp.

$edit_link  : string

URL to edit the task.

$estimate  : float

The estimated task length.

$id  : string

The task id.

$indent  : int

This task's idention (child) level.

$internaltags  : array<string|int, mixed>

Task tags from the storage backend (e.g. Kolab)

$lastChild  : bool

Whether this is the last sub-task.

$methods  : array<string|int, mixed>

The particular alarm methods overridden for this task.

$modified  : Horde_Date

The last modification time.

$modifiedby  : string

The last-modifier string.

$name  : string

The task title.

$organizer  : string

Task organizer

$otherCaldavAttributes  : array<string|int, mixed>

$ourCaldavAttributes  : array<string|int, mixed>

$owner  : string

The task owner.

$parent  : Nag_Task

The parent task.

$parent_id  : string

The parent task's id.

$priority  : int

The task priority from 1 = highest to 5 = lowest.

$private  : bool

Whether the task is private.

$recurrence  : Horde_Date_Recurrence

Recurrence rules for recurring tasks.

$snooze  : int

Snooze minutes for this event's alarm.

$start  : int

The start date timestamp.

$status  : int

The assignment status of this task.

$tasklist  : string

This task's tasklist id.

$tasklist_name  : string

This task's tasklist name.

$uid  : string

The task uid.

$view_link  : string

URL to view the task.

$_dict  : array<string|int, mixed>

Task id => pointer dictionary.

$_inlist  : bool

Internal flag.

$_pointer  : int

Internal pointer.

$_storage  : Nag_Driver

A storage driver.

$_tags  : string

Task tags (lazy loaded).

__clone()  : mixed

Deep clone so we can clone the child objects too.

__construct()  : mixed

Constructor.

__get()  : mixed

Getter.

__set()  : mixed

Setter.

actuals()  : int

Returns the actual length for this and any sub tasks.

add()  : mixed

Adds a sub task to this task.

backgroundColor()  : string

Returns the background color.

childrenCompleted()  : bool

Returns whether all sub tasks are completed.

childrenOverdue()  : bool

Returns whether any tasks in the list are overdue.

count()  : int

Returns the number of tasks including this and any sub tasks.

each()  : mixed

Returns the next task iterating through all tasks and sub tasks.

estimation()  : int

Returns the estimated length for this and any sub tasks.

foregroundColor()  : string

Returns the foreground color.

fromASTask()  : mixed

Create a nag Task object from an activesync message

fromiCalendar()  : mixed

Creates a task from a Horde_Icalendar_Vtodo object.

get()  : Nag_Task

Returns a sub task by its id.

getFormattedDescription()  : string

Format the description - link URLs, etc.

getNextDue()  : Horde_Date|null

Returns the next due date of this task.

getNextStart()  : Horde_Date

Returns the next start date of this task.

getParent()  : mixed

Returns the parent task of this task, if one exists.

getSlice()  : Nag_Task

Helper method for getting only a slice of the total tasks in this list.

hasSubTasks()  : bool

Returns whether this task contains any sub tasks.

hasTask()  : Nag_Task|false

Return the task, if present anywhere in this tasklist, regardless of child depth.

hasTasks()  : bool

Returns whether this is a task (not a container) or contains any sub tasks.

loadChildren()  : mixed

Loads all sub-tasks.

loadTags()  : mixed

Recursively loads tags for all tasks contained in this object.

merge()  : mixed

Merges a task hash into this task object.

mergeChildren()  : mixed

Merges an array of tasks into this task's children.

orphan()  : mixed

Disconnect this task from any child tasks. Used when building search result sets since child tasks will be re-added if they actually match the result, and there is no guarentee that a tasks's parent will be present in the result set.

process()  : mixed

Processes a list of tasks by adding action links, obscuring details of private tasks and calculating indentation.

recurs()  : bool

Returns whether this task is a recurring task.

reset()  : mixed

Resets the tasks iterator.

save()  : mixed

Saves this task in the storage backend.

sort()  : mixed

Sorts sub tasks by the given criteria.

synchronizeTags()  : mixed

Syncronizes tags from the tagging backend with the task storage backend, if necessary.

toAlarm()  : array<string|int, mixed>

Returns an alarm hash of this task suitable for Horde_Alarm.

toASTask()  : Horde_ActiveSync_Message_Task

Create an AS message from this task

toggleComplete()  : mixed

Toggles completion status of this task. Moves a recurring task to the next occurence on completion. Enforces the rule that sub tasks must be completed before parent tasks.

toHash()  : array<string|int, mixed>

Returns a hash representation for this task.

toiCalendar()  : Horde_Icalendar_Vtodo

Exports this task in iCalendar format.

toJson()  : object

Returns a simple object suitable for json transport representing this task.

treeIcons()  : string

Returns the HTML code for any tree icons, when displaying this task in a tree view.