Docs For Class JHtmlSidebar

Description

Utility class to render a list view sidebar

abstract:
since: 3.0

Located in /libraries/cms/html/sidebar.php (line 19)

Variable Summary

static string $action

static array $entries

static array $filters

Method Summary

static void addEntry (string $name, [string $link = ''], [bool $active = false])

static void addFilter (string $label, string $name, string $options, [bool $noDefault = false])

static string getAction ()

static array getEntries ()

static array getFilters ()

static string render ()

static void setAction (string $action)

Variables

static string $action = '' (line 43)

Value for the action attribute of the form.

since: 3.0
access: protected

static array $entries = array() (line 27)

Menu entries

since: 3.0
access: protected

static array $filters = array() (line 35)

Filters

since: 3.0
access: protected

Methods

static addEntry (line 81)

Method to add a menu item to submenu.

since: 3.0
access: public

static void addEntry (string $name, [string $link = ''], [bool $active = false])

string $name: Name of the menu item.
string $link: URL of the menu item.
bool $active: True if the item is active, false otherwise.

static addFilter (line 110)

Method to add a filter to the submenu

since: 3.0
access: public

static void addFilter (string $label, string $name, string $options, [bool $noDefault = false])

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 the label as the empty option

static getAction (line 148)

Get value for the action attribute of the filter form

since: 3.0
access: public

static string getAction ()

static getEntries (line 93)

Returns an array of all submenu entries

since: 3.0
access: public

static array getEntries ()

static getFilters (line 122)

Returns an array of all filters

since: 3.0
access: public

static array getFilters ()

static render (line 52)

Render the sidebar.

return: The necessary HTML to display the sidebar
since: 3.0
access: public

static string render ()

static setAction (line 136)

Set value for the action attribute of the filter form

since: 3.0
access: public

static void setAction (string $action)

string $action: Value for the action attribute of the form