Documentation

Nag_View_List
in package

Task list view.

Copyright 2011-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (BSD). If you did not did not receive this file, see http://www.horde.org/licenses/bsdl.php.

Tags
author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

$_browser  : Nag_TagBrowser
Tag browser
$_haveSearch  : bool
Flag to indicate if we have a search.
$_showTagBrowser  : bool
Flag to indicate whether or not to show the tag browser
$_smartShare  : Horde_Share_Object_Base
Share representing the current smarlist (if being viewed).
$_tasks  : Nag_Task
The loaded tasks.
$_title  : string
Page title
$_vars  : Horde_Variables
Horde_Variables
__construct()  : Nag_View_List
Const'r
render()  : string
Renders the view.
_checkSortValue()  : mixed
Helper to check/update the sort prefs
_doDeleteSmartList()  : mixed
Delete a SmartList.
_doSearch()  : mixed
Performs a Task search. self::_tasks is populated with the results.
_getRelatedTags()  : string
Get HTML to display the related tags links.
_getTagTrail()  : string
Get HTML to represent the currently selected tags.
_handleActions()  : mixed
Helper to handle any incoming actions.
_linkAddTag()  : string
Get HTML for a link to add a new tag to the current search.
_linkRemoveTag()  : string
Get HTML for a link to remove a tag from the current search.
_loadTasks()  : mixed
Load the full, sorted task list.

Properties

$_haveSearch

Flag to indicate if we have a search.

protected bool $_haveSearch = \false

$_showTagBrowser

Flag to indicate whether or not to show the tag browser

protected bool $_showTagBrowser = \true

$_smartShare

Share representing the current smarlist (if being viewed).

protected Horde_Share_Object_Base $_smartShare

$_title

Page title

protected string $_title

$_vars

Horde_Variables

protected Horde_Variables $_vars

Methods

__construct()

Const'r

public __construct(Horde_Variables $vars) : Nag_View_List
Parameters
$vars : Horde_Variables

Variables for the view.

Return values
Nag_View_List

render()

Renders the view.

public render(Horde_PageOutput $output) : string
Parameters
$output : Horde_PageOutput

The output object.

Return values
string

The HTML needed to render the view.

_checkSortValue()

Helper to check/update the sort prefs

protected _checkSortValue() : mixed
Return values
mixed

_doDeleteSmartList()

Delete a SmartList.

protected _doDeleteSmartList() : mixed
Return values
mixed

_doSearch()

Performs a Task search. self::_tasks is populated with the results.

protected _doSearch() : mixed
Tags
throws
Nag_Exception
Return values
mixed

_getRelatedTags()

Get HTML to display the related tags links.

protected _getRelatedTags() : string
Return values
string

_getTagTrail()

Get HTML to represent the currently selected tags.

protected _getTagTrail() : string
Return values
string

_handleActions()

Helper to handle any incoming actions.

protected _handleActions([mixed $action = null ]) : mixed
Parameters
$action : mixed = null
Return values
mixed

_linkAddTag()

Get HTML for a link to add a new tag to the current search.

protected _linkAddTag(string $tag) : string
Parameters
$tag : string

The tag we want to add.

Return values
string

_linkRemoveTag()

Get HTML for a link to remove a tag from the current search.

protected _linkRemoveTag(string $tag) : string
Parameters
$tag : string

The tag we want the link for.

Return values
string

_loadTasks()

Load the full, sorted task list.

protected _loadTasks([mixed $lists = null ]) : mixed
Parameters
$lists : mixed = null
Return values
mixed

Search results