Documentation

Nag_TagBrowser extends Horde_Core_TagBrowser
in package

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.

Tags
author

Michael J Rubinsky mrubinsk@horde.org

category

Horde

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

$_app  : string
Application that the tag browser is for.
$_completed  : int
The 'completed' filter value.
$_tasks  : Nag_Task
Cache the last tag search to avoid having to retrieve the tags from the backend twice.
getSlice()  : Nag_Task
Fetch the matching resources that should appear on the current page
getTagTrail()  : Return
Get breadcrumb style navigation html for choosen tags
setFilter()  : mixed
Set the Nag::VIEW_* constant for the browser.
_runSearch()  : array<string|int, mixed>
Override the default tag search in order to filter by the 'completed' filter.

Properties

$_app

Application that the tag browser is for.

protected string $_app = 'nag'

$_completed

The 'completed' filter value.

protected int $_completed = \Nag::VIEW_ALL

$_tasks

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

protected Nag_Task $_tasks

Methods

getSlice()

Fetch the matching resources that should appear on the current page

public getSlice(int $page[, int $perpage = null ]) : Nag_Task
Parameters
$page : int

Start page.

$perpage : int = null

Number of tasks per page.

Return values
Nag_Task

A list of tasks.

getTagTrail()

Get breadcrumb style navigation html for choosen tags

public getTagTrail() : Return
Return values
Return

information useful for building a tag trail.

setFilter()

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

public setFilter(int $completed) : mixed
Parameters
$completed : int

The Nag::VIEW_* constant to filter the results

Return values
mixed

_runSearch()

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

protected _runSearch() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array of task UIDs.

Search results