• Home
  • Trean_View_BookmarkList

PHP Class Trean_View_BookmarkList, 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
$_bookmarks array The loaded bookmarks.
$_browser Trean_TagBrowser Tag Browser
$_noSearch boolean Flag to indicate we have an empty search.
$_page integer Current page
$_perPage integer Bookmarks to display per page
$_showTagBrowser boolean Flag to indicate whether or not to show the tag browser

Public Methods

Method Description
__construct ( $bookmarks = null, $browser = null ) Const'r
hasBookmarks ( ) : boolean Returns whether bookmarks currently exist.
render ( $title = null ) Renders the view.
showTagBrowser ( $showTagBrowser ) Toggle showing of the tag browser

Protected Methods

Method Description
_getBookmarkList ( ) : string Returns the HTML to display a bookmark list.
_getBookmarks ( ) Loads the bookmarks from the backend.
_getRelatedTags ( ) : string Get HTML to display the related tags links.
_getTagTrail ( ) : string Get HTML to represent the currently selected tags.
_linkRemoveTag ( string $tag ) : string Get HTML for a link to remove a tag from the current search.

Method Details

__construct() public method

Const'r
public __construct ( $bookmarks = null, $browser = null )

_getBookmarkList() protected method

Returns the HTML to display a bookmark list.
protected _getBookmarkList ( ) : string
return string Bookmark list HTML.

_getBookmarks() protected method

Loads the bookmarks from the backend.
protected _getBookmarks ( )

_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

_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

hasBookmarks() public method

Returns whether bookmarks currently exist.
public hasBookmarks ( ) : boolean
return boolean True if there exist any bookmarks in the backend.

render() public method

Renders the view.
public render ( $title = null )

showTagBrowser() public method

Toggle showing of the tag browser
public showTagBrowser ( $showTagBrowser )

Property Details

$_bookmarks protected property

The loaded bookmarks.
protected array $_bookmarks
return array

$_browser protected property

Tag Browser
protected Trean_TagBrowser $_browser
return Trean_TagBrowser

$_noSearch protected property

Flag to indicate we have an empty search.
protected bool $_noSearch
return boolean

$_page protected property

Current page
protected int $_page
return integer

$_perPage protected property

Bookmarks to display per page
protected int $_perPage
return integer

$_showTagBrowser protected property

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