\Nag

secondsToString()

secondsToString(integer  $seconds) : string

Parameters

Returns

parseDate()

parseDate(string  $date, boolean  $withtime = true) : \Horde_Date

Parses a complete date-time string into a Horde_Date object.

Parameters

Throws

\Horde_Date_Exception

Returns

The parsed date.

listTasks()

listTasks(\arary  $options = array()) : \Nag_Task

Retrieves the current user's task list from storage.

This function will also sort the resulting list, if requested.

Parameters

Returns

A list of the requested tasks.

getTask()

getTask(string  $tasklist, string  $task) : \Nag_Task

Returns a single task.

Parameters

Returns

The task hash.

countTasks()

countTasks() : integer

Returns the number of taks in task lists that the current user owns.

Returns

The number of tasks that the user owns.

createTasksFromText()

createTasksFromText(string  $text, string  $tasklist = null) : array

Imports one or more tasks parsed from a string.

Parameters

Returns

The UIDs of all tasks that were added.

listAlarms()

listAlarms(integer  $date, array  $tasklists = null) : array

Returns all the alarms active right on $date.

Parameters

Returns

An array of Nag_Task objects with alarms active on $date.

listTasklists()

listTasklists(boolean  $owneronly = false, integer  $permission = \Horde_Perms::SHOW, boolean  $smart = true) : array

Lists all task lists a user has access to.

Parameters

Returns

The task lists.

hasPermission()

hasPermission(string  $tasklist, integer  $perm) : boolean

Returns whether the current user has certain permissions on a tasklist.

Parameters

Returns

True if the current user has the requested permissions.

getDefaultTasklist()

getDefaultTasklist(integer  $permission = \Horde_Perms::SHOW) : string

Returns the default tasklist for the current user at the specified permissions level.

Parameters

Returns

The default tasklist or null if none.

addTasklist()

addTasklist(array  $info, boolean  $display = true) : \Horde_Share

Creates a new share.

Parameters

Returns

The new share.

updateTasklist()

updateTasklist(\Horde_Share_Object  $tasklist, array  $info) 

Updates an existing share.

Parameters

Throws

\Horde_Exception_PermissionDenied

\Nag_Exception

deleteTasklist()

deleteTasklist(\Horde_Share_Object  $tasklist) 

Deletes a task list.

Parameters

Throws

\Nag_Exception

\Horde_Exception_PermissionDenied

getLabel()

getLabel(  $tasklist) : string

Returns the label to be used for a task list.

Attaches the owner name of shared task lists if necessary.

Parameters

Returns

The task list's label.

getUrl()

getUrl(integer  $type,   $tasklist) : string

Returns a DAV URL to be used for a task list.

Parameters

Throws

\Horde_Exception

Returns

The task list's URL.

randomColor()

randomColor() : string

Returns a random CSS color.

Returns

A random CSS color string.

buildPriorityWidget()

buildPriorityWidget(string  $name, integer  $selected = -1) : string

Builds the HTML for a priority selection widget.

Parameters

Returns

The HTML widget.

buildCheckboxWidget()

buildCheckboxWidget(string  $name, integer  $checked) : string

Builds the HTML for a checkbox widget.

Parameters

string	$name	The name of the widget.
integer	$checked	The default checkbox state.

Returns

string —

HTML for a checkbox representing the completion state.

formatDate()

formatDate(string  $unixdate = '', boolean  $hours = true) : string

Formats the given Unix-style date string.

Parameters

string	$unixdate	The Unix-style date value to format.
boolean	$hours	Whether to add hours.

Returns

string —

The formatted due date string.

formatCompletion()

formatCompletion(integer  $completed) : string

Returns the string representation of the given completion status.

Parameters

integer

$completed

The completion value.

Returns

string —

The HTML representation of $completed.

formatPriority()

formatPriority(integer  $priority) : string

Returns a colored representation of a priority.

Parameters

integer

$priority

The priority level.

Returns

string —

The HTML representation of $priority.

formatAlarm()

formatAlarm(integer  $value) : string

Returns the string matching the given alarm value.

Parameters

integer

$value

The alarm value in minutes.

Returns

string —

The formatted alarm string.

formatOrganizer()

formatOrganizer(string  $organizer, boolean  $link = false) : string

Returns formatted string representing a task organizer.

Parameters

string	$organizer	The organinzer, as an email or mailto: format.
boolean	$link	Whether to link to an email compose screen.

Returns

string —

The formatted organizer name.

formatAssignee()

formatAssignee(string  $assignee, boolean  $link = false) : string

Returns the full name and a compose to message an assignee.

Parameters

string	$assignee	The assignee's user name.
boolean	$link	Whether to link to an email compose screen.

Returns

string —

The formatted assignee name.

initialize()

initialize() 

Initial app setup code.

status()

status() 

Trigger notifications.

sendNotification()

sendNotification(string  $action, \Nag_Task  $task, \Nag_Task  $old_task = null) 

Sends email notifications that a task has been added, edited, or deleted to users that want such notifications.

Parameters

string	$action	The event action. One of "add", "edit", or "delete".
\Nag_Task	$task	The changed task.
\Nag_Task	$old_task	The original task if $action is "edit".

Throws

\Nag_Exception

buildMimeMessage()

buildMimeMessage(\Horde_View  $view, string  $template, \Horde_Mime_Part  $image) : \Horde_Mime_Part

Builds the body MIME part of a multipart message.

Parameters

\Horde_View	$view	A view to render the HTML and plain text templates for the messate.
string	$template	The template base name for the view.
\Horde_Mime_Part	$image	The MIME part of a related image.

Returns

\Horde_Mime_Part —

A multipart/alternative MIME part.

getImagePart()

getImagePart(string  $file) : \Horde_Mime_Part

Returns a MIME part for an image to be embedded into a HTML document.

Parameters

string

$file

An image file name.

Returns

\Horde_Mime_Part —

A MIME part representing the image.

getUserName()

getUserName(string  $uid) : string

Returns the real name, if available, of a user.

Parameters

string

$uid

The userid of the user to retrieve

Returns

string —

The fullname of the user.

_sortByPriority()

_sortByPriority(array  $a, array  $b) : integer

Comparison function for sorting tasks by priority.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

1 if task one is greater, -1 if task two is greater; 0 if they are equal.

_rsortByPriority()

_rsortByPriority(array  $a, array  $b) : integer

Comparison function for reverse sorting tasks by priority.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

-1 if task one is greater, 1 if task two is greater; 0 if they are equal.

_sortByName()

_sortByName(array  $a, array  $b) : integer

Comparison function for sorting tasks by name.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

1 if task one is greater, -1 if task two is greater; 0 if they are equal.

_rsortByName()

_rsortByName(array  $a, array  $b) : integer

Comparison function for reverse sorting tasks by name.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

-1 if task one is greater, 1 if task two is greater; 0 if they are equal.

_sortByAssignee()

_sortByAssignee(array  $a, array  $b) : integer

Comparison function for sorting tasks by assignee.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

1 if task one is greater, -1 if task two is greater; 0 if they are equal.

_rsortByAssignee()

_rsortByAssignee(array  $a, array  $b) : integer

Comparison function for reverse sorting tasks by assignee.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

-1 if task one is greater, 1 if task two is greater; 0 if they are equal.

_sortByEstimate()

_sortByEstimate(array  $a, array  $b) : integer

Comparison function for sorting tasks by assignee.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

1 if task one is greater, -1 if task two is greater; 0 if they are equal.

_rsortByEstimate()

_rsortByEstimate(array  $a, array  $b) : integer

Comparison function for reverse sorting tasks by name.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

-1 if task one is greater, 1 if task two is greater; 0 if they are equal.

_sortByDue()

_sortByDue(array  $a, array  $b) : integer

Comparison function for sorting tasks by due date.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

1 if task one is greater, -1 if task two is greater; 0 if they are equal.

_rsortByDue()

_rsortByDue(array  $a, array  $b) : integer

Comparison function for reverse sorting tasks by due date.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

-1 if task one is greater, 1 if task two is greater, 0 if they are equal.

_sortByStart()

_sortByStart(array  $a, array  $b) : integer

Comparison function for sorting tasks by start date.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

1 if task one is greater, -1 if task two is greater; 0 if they are equal.

_rsortByStart()

_rsortByStart(array  $a, array  $b) : integer

Comparison function for reverse sorting tasks by start date.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

-1 if task one is greater, 1 if task two is greater, 0 if they are equal.

_sortByCompletion()

_sortByCompletion(array  $a, array  $b) : integer

Comparison function for sorting tasks by completion status.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

1 if task one is greater, -1 if task two is greater; 0 if they are equal.

_rsortByCompletion()

_rsortByCompletion(array  $a, array  $b) : integer

Comparison function for reverse sorting tasks by completion status.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

-1 if task one is greater, 1 if task two is greater; 0 if they are equal.

_sortByOwner()

_sortByOwner(array  $a, array  $b) : integer

Comparison function for sorting tasks by owner.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

1 if task one is greater, -1 if task two is greater; 0 if they are equal.

_rsortByOwner()

_rsortByOwner(array  $a, array  $b) : integer

Comparison function for reverse sorting tasks by owner.

Parameters

array	$a	Task one.
array	$b	Task two.

Returns

integer —

-1 if task one is greater, 1 if task two is greater; 0 if they are equal.

getSyncLists()

getSyncLists() : array

Returns the tasklists that should be used for syncing.

Returns

array —

An array of task list ids

getUserEmail()

getUserEmail(  $user) 

Parameters

$user

responseFromICal()

responseFromICal(string  $response) : string

Maps an iCalendar attendee response string to the corresponding Nag value.

Parameters

string

$response

The attendee response.

Returns

string —

The Nag response value.

sendITipNotifications()

sendITipNotifications(\Nag_Task  $task, \Horde_Notification_Handler  $notification, integer  $action, \Horde_Date  $instance = null, string  $range = null) 

Sends out iTip task notification to the assignee.

Can be used to send task invitations, updates, and cancellations.

Parameters

\Nag_Task	$task	The task in question.
\Horde_Notification_Handler	$notification	A notification object used to show result status.
integer	$action	The type of notification to send. One of the Nag::ITIP_* values.
\Horde_Date	$instance	If cancelling a single instance of a recurring task, the date of this instance.
string	$range	The range parameter if this is a recurring event. Possible values are self::RANGE_THISANDFUTURE

_notificationPref()

_notificationPref(string  $user, string  $mode, string  $tasklist = null) : boolean

Returns whether a user wants email notifications for a tasklist.

Parameters

string	$user	A user name.
string	$mode	The check "mode". If "owner", the method checks if the user wants notifications only for tasklists he owns. If "read", the method checks if the user wants notifications for all tasklists he has read access to, or only for shown tasklists and the specified tasklist is currently shown.
string	$tasklist	The name of the tasklist if mode is "read".

Returns

boolean —

True if the user wants notifications for the tasklist.

_getOwner()

_getOwner(\Nag_Task  $task) : string

Returns the owner of a task.

Parameters

\Nag_Task

$task

A task.

Returns

string —

The task's owner.

×

Nag.php