API Documentation
\

\Horde_View_Topbar

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.

Summary

Methods
Properties
Constants
__construct()
render()
__toString()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(array  $config = array())

Constructor.

Parameters

array $config

Configuration key-value pairs.

render()

render(string  $name = 'topbar',   $locals = array()) : string

Returns the HTML code for the topbar.

Parameters

string $name

The template to process.
$locals

Returns

string —

The topbar's HTML code.

__toString()

__toString() : string

Handler for string casting.

Returns

string —

The sidebar's HTML code.