Class JHtmlSidebar

Utility class to render a list view sidebar

Abstract
Package: Joomla\Libraries\HTML
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 3.0
Located at cms/html/sidebar.php

Methods summary

`public static string`	# `render( )` Render the sidebar. Render the sidebar. Returns `string` - The necessary HTML to display the sidebar Since 3.0
`public static`	# `addEntry( string $name, string $link = '', boolean $active = false )` Method to add a menu item to submenu. Method to add a menu item to submenu. Parameters `$name` `string` - $name Name of the menu item. `$link` `string` - $link URL of the menu item. `$active` `boolean` - $active True if the item is active, false otherwise. Since 3.0
`public static array`	# `getEntries( )` Returns an array of all submenu entries Returns an array of all submenu entries Returns `array` Since 3.0
`public static`	# `addFilter( string $label, string $name, string $options, boolean $noDefault = false )` Method to add a filter to the submenu Method to add a filter to the submenu Parameters `$label` `string` - $label Label for the menu item. `$name` `string` - $name Name for the filter. Also used as id. `$options` `string` - $options Options for the select field. `$noDefault` `boolean` - $noDefault Don't the label as the empty option Since 3.0
`public static array`	# `getFilters( )` Returns an array of all filters Returns an array of all filters Returns `array` Since 3.0
`public static`	# `setAction( string $action )` Set value for the action attribute of the filter form Set value for the action attribute of the filter form Parameters `$action` `string` - $action Value for the action attribute of the form Since 3.0
`public static string`	# `getAction( )` Get value for the action attribute of the filter form Get value for the action attribute of the filter form Returns `string` Since 3.0

Magic methods summary

Properties summary

`protected static array`	`$entries`	# Menu entries Menu entries Since 3.0
`protected static array`	`$filters`	# Filters Filters Since 3.0
`protected static string`	`$action`	# Value for the action attribute of the form. Value for the action attribute of the form. Since 3.0

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JHtmlSidebar

Methods summary

Returns

Since

Parameters

Since

Returns

Since

Parameters

Since

Returns

Since

Parameters

Since

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since