JHtmlSidebar

Utility class to render a list view sidebar

abstract
since

3.0

package

Joomla.Libraries

Methods

addEntry

Method to add a menu item to submenu.

addEntry(string $name, string $link = '', boolean $active = false) : void
static
since

3.0

Arguments

$name

stringName of the menu item.

$link

stringURL of the menu item.

$active

booleanTrue if the item is active, false otherwise.

addFilter

Method to add a filter to the submenu

addFilter(string $label, string $name, string $options, boolean $noDefault = false) : void
static
since

3.0

Arguments

$label

stringLabel for the menu item.

$name

stringName for the filter. Also used as id.

$options

stringOptions for the select field.

$noDefault

booleanDon't the label as the empty option

getAction

Get value for the action attribute of the filter form

getAction() : string
static
since

3.0

Response

string

getEntries

Returns an array of all submenu entries

getEntries() : array
static
since

3.0

Response

array

getFilters

Returns an array of all filters

getFilters() : array
static
since

3.0

Response

array

render

Render the sidebar.

render() : string
static
since

3.0

Response

stringThe necessary HTML to display the sidebar

setAction

Set value for the action attribute of the filter form

setAction(string $action) : void
static
since

3.0

Arguments

$action

stringValue for the action attribute of the form

Properties

entries

Menu entries

static
since

3.0

Type(s)

array

filters

Filters

static
since

3.0

Type(s)

array

action

Value for the action attribute of the form.

static
since

3.0

Type(s)

string