Documentation

Horde_View_Topbar extends Horde_View
in package

This is a view of the Horde topbar.

Useful properties:

  • subinfo: (string) Right-aligned content of the sub-bar.
  • search: (boolean) Whether to show the search bar.
  • searchAction: (string) The form action attribute of the search form.
  • searchMenu: (boolean) whether to show a drop down icon inside the search field.
  • searchLabel: (string) Ghost label of the search field.
  • searchParameters: (array) Key-value-hash with additional hidden form fields.

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

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

Tags
author

Jan Schneider jan@horde.org

category

Horde

license

http://www.horde.org/licenses/lgpl LGPL-2

Table of Contents

__construct()  : mixed
Constructor.
__toString()  : string
Handler for string casting.
render()  : string
Returns the HTML code for the topbar.

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = array() ]) : mixed
Parameters
$config : array<string|int, mixed> = array()

Configuration key-value pairs.

Return values
mixed —

__toString()

Handler for string casting.

public __toString() : string
Return values
string —

The sidebar's HTML code.

render()

Returns the HTML code for the topbar.

public render([string $name = 'topbar' ][, mixed $locals = array() ]) : string
Parameters
$name : string = 'topbar'

The template to process.

$locals : mixed = array()
Return values
string —

The topbar's HTML code.

Search results