PHP Class Nag_View_List, horde

Copyright 2011-2016 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.
Author: Michael J Rubinsky ([email protected])
Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_browser Nag_TagBrowser Tag browser
$_haveSearch boolean Flag to indicate if we have a search.
$_showTagBrowser boolean 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

Public Methods

Method Description
__construct ( Horde_Variables $vars ) : Nag_View_List Const'r
render ( Horde_PageOutput $output ) : string Renders the view.

Protected Methods

Method Description
_checkSortValue ( ) Helper to check/update the sort prefs
_doDeleteSmartList ( ) Delete a SmartList.
_doSearch ( ) 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 ( $action = null ) Helper to handle any incoming actions.
_linkAddTag ( string $tag ) : string Get HTML for a link to add a new tag to the current search.
_linkRemoveTag ( string $tag ) : string Get HTML for a link to remove a tag from the current search.
_loadTasks ( $lists = null ) Load the full, sorted task list.

Method Details

__construct() public method

Const'r
public __construct ( Horde_Variables $vars ) : Nag_View_List
$vars Horde_Variables Variables for the view.
return Nag_View_List

_checkSortValue() protected method

Helper to check/update the sort prefs
protected _checkSortValue ( )

_doDeleteSmartList() protected method

Delete a SmartList.
protected _doDeleteSmartList ( )

_doSearch() protected method

Performs a Task search. self::_tasks is populated with the results.
protected _doSearch ( )

_getRelatedTags() protected method

Get HTML to display the related tags links.
protected _getRelatedTags ( ) : string
return string

_getTagTrail() protected method

Get HTML to represent the currently selected tags.
protected _getTagTrail ( ) : string
return string

_handleActions() protected method

Helper to handle any incoming actions.
protected _handleActions ( $action = null )

_linkAddTag() protected method

Get HTML for a link to add a new tag to the current search.
protected _linkAddTag ( string $tag ) : string
$tag string The tag we want to add.
return string

_linkRemoveTag() protected method

Get HTML for a link to remove a tag from the current search.
protected _linkRemoveTag ( string $tag ) : string
$tag string The tag we want the link for.
return string

_loadTasks() protected method

Load the full, sorted task list.
protected _loadTasks ( $lists = null )

render() public method

Renders the view.
public render ( Horde_PageOutput $output ) : string
$output Horde_PageOutput The output object.
return string The HTML needed to render the view.

Property Details

$_browser protected property

Tag browser
protected Nag_TagBrowser $_browser
return Nag_TagBrowser

$_haveSearch protected property

Flag to indicate if we have a search.
protected bool $_haveSearch
return boolean

$_showTagBrowser protected property

Flag to indicate whether or not to show the tag browser
protected bool $_showTagBrowser
return boolean

$_smartShare protected property

Share representing the current smarlist (if being viewed).
protected Horde_Share_Object_Base $_smartShare
return Horde_Share_Object_Base

$_tasks protected property

The loaded tasks.
protected Nag_Task $_tasks
return Nag_Task

$_title protected property

Page title
protected string $_title
return string

$_vars protected property

Horde_Variables
protected Horde_Variables $_vars
return Horde_Variables