Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Sidebar - list of methods

Utility class to render a list view sidebar
Package: Joomla\CMS\HTML\Helpers
Copyright: (C) 2012 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/HTML/Helpers/Sidebar.php
Project: Joomla

Method Summary

public static string
()

Render the sidebar.
Returns
  • string The necessary HTML to display the sidebar
Since
  • 3.0
Show source code of this method: render Source Code

public static void
(mixed $name, mixed $link = '', mixed $active = false)

Method to add a menu item to submenu.
Parameters
  • string $name Name of the menu item.
  • string $link URL of the menu item.
  • bool $active True if the item is active, false otherwise.
Returns
  • void
Since
  • 3.0
Show source code of this method: addEntry Source Code

public static array
()

Returns an array of all submenu entries
Returns
  • array
Since
  • 3.0
Show source code of this method: getEntries Source Code

public static void
(mixed $label, mixed $name, mixed $options, mixed $noDefault = false)

Method to add a filter to the submenu
Parameters
  • string $label Label for the menu item.
  • string $name Name for the filter. Also used as id.
  • string $options Options for the select field.
  • bool $noDefault Don't show the label as the empty option
Returns
  • void
Since
  • 3.0
Show source code of this method: addFilter Source Code

public static array
()

Returns an array of all filters
Returns
  • array
Since
  • 3.0
Show source code of this method: getFilters Source Code

public static void
(mixed $action)

Set value for the action attribute of the filter form
Parameters
  • string $action Value for the action attribute of the form
Returns
  • void
Since
  • 3.0
Show source code of this method: setAction Source Code

public static string
()

Get value for the action attribute of the filter form
Returns
  • string
Since
  • 3.0
Show source code of this method: getAction Source Code

Properties Summary

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

Tags Summary

Since
3.0