API Documentation
\
Nag
Backup

\Nag_TagBrowser

Nag_TagBrowser:: class provides logic for dealing with tag browsing.

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

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

Summary

Methods
Properties
Constants
getTagTrail()
getSlice()
setFilter()
No public properties found
No constants found
_runSearch()
$_app
$_completed
$_tasks
N/A
No private methods found
No private properties found
N/A

Properties

$_app

$_app : string

Application that the tag browser is for.

Type

string

$_completed

$_completed : integer

The 'completed' filter value.

Type

integer

$_tasks

$_tasks : \Nag_Task

Cache the last tag search to avoid having to retrieve the tags from the backend twice.

Type

\Nag_Task

Methods

getTagTrail()

getTagTrail() : \Return

Get breadcrumb style navigation html for choosen tags

Returns

\Return —

information useful for building a tag trail.

getSlice()

getSlice(integer  $page, integer  $perpage = null) : \Nag_Task

Fetch the matching resources that should appear on the current page

Parameters

integer $page

Start page.
integer $perpage

Number of tasks per page.

Returns

\Nag_Task —

A list of tasks.

setFilter()

setFilter(integer  $completed)

Set the Nag::VIEW_* constant for the browser.

Parameters

integer $completed

The Nag::VIEW_* constant to filter the results

_runSearch()

_runSearch() : array

Override the default tag search in order to filter by the 'completed' filter.

Returns

array —

An array of task UIDs.