PHP Class Nag_TagBrowser, horde

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

Protected Properties

Property Type Description
$_app string Application that the tag browser is for.
$_completed integer The 'completed' filter value.
$_tasks Nag_Task Cache the last tag search to avoid having to retrieve the tags from the backend twice.

Public Methods

Method Description
getSlice ( integer $page, integer $perpage = null ) : Nag_Task Fetch the matching resources that should appear on the current page
getTagTrail ( ) : Return Get breadcrumb style navigation html for choosen tags
setFilter ( integer $completed ) Set the Nag::VIEW_* constant for the browser.

Protected Methods

Method Description
_runSearch ( ) : array Override the default tag search in order to filter by the 'completed' filter.

Method Details

_runSearch() protected method

Override the default tag search in order to filter by the 'completed' filter.
protected _runSearch ( ) : array
return array An array of task UIDs.

getSlice() public method

Fetch the matching resources that should appear on the current page
public getSlice ( integer $page, integer $perpage = null ) : Nag_Task
$page integer Start page.
$perpage integer Number of tasks per page.
return Nag_Task A list of tasks.

getTagTrail() public method

Get breadcrumb style navigation html for choosen tags
public getTagTrail ( ) : Return
return Return information useful for building a tag trail.

setFilter() public method

Set the Nag::VIEW_* constant for the browser.
public setFilter ( integer $completed )
$completed integer The Nag::VIEW_* constant to filter the results

Property Details

$_app protected property

Application that the tag browser is for.
protected string $_app
return string

$_completed protected property

The 'completed' filter value.
protected int $_completed
return integer

$_tasks protected property

Cache the last tag search to avoid having to retrieve the tags from the backend twice.
protected Nag_Task $_tasks
return Nag_Task