API Documentation
\

\Trean_View_BookmarkList

Tag browsing

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.

Summary

Methods
Properties
Constants
__construct()
showTagBrowser()
hasBookmarks()
render()
No public properties found
No constants found
_getBookmarks()
_getBookmarkList()
_getRelatedTags()
_getTagTrail()
_linkRemoveTag()
$_browser
$_bookmarks
$_page
$_perPage
$_noSearch
$_showTagBrowser
N/A
No private methods found
No private properties found
N/A

Properties

$_bookmarks

$_bookmarks : array

The loaded bookmarks.

Type

array

$_page

$_page : integer

Current page

Type

integer

$_perPage

$_perPage : integer

Bookmarks to display per page

Type

integer

$_noSearch

$_noSearch : boolean

Flag to indicate we have an empty search.

Type

boolean

$_showTagBrowser

$_showTagBrowser : boolean

Flag to indicate whether or not to show the tag browser

Type

boolean

Methods

__construct()

__construct(  $bookmarks = null,   $browser = null)

Const'r

Parameters

$bookmarks
$browser

showTagBrowser()

showTagBrowser(  $showTagBrowser)

Toggle showing of the tag browser

Parameters

$showTagBrowser

hasBookmarks()

hasBookmarks() : boolean

Returns whether bookmarks currently exist.

Returns

boolean —

True if there exist any bookmarks in the backend.

render()

render(  $title = null)

Renders the view.

Parameters

$title

_getBookmarks()

_getBookmarks()

Loads the bookmarks from the backend.

_getBookmarkList()

_getBookmarkList() : string

Returns the HTML to display a bookmark list.

Returns

string —

Bookmark list HTML.

_getRelatedTags()

_getRelatedTags() : string

Get HTML to display the related tags links.

Returns

string

_getTagTrail()

_getTagTrail() : string

Get HTML to represent the currently selected tags.

Returns

string

_linkRemoveTag()

_linkRemoveTag(string  $tag) : string

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

Parameters

string $tag

The tag we want the link for.

Returns

string