JHtmlSidebar
Utility class to render a list view sidebar
| 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
| 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
| 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 show the label as the empty option
getAction
Get value for the action attribute of the filter form
getAction() : string
| since |
3.0 |
|---|
Response
string
getEntries
Returns an array of all submenu entries
getEntries() : array
| since |
3.0 |
|---|
Response
array
getFilters
Returns an array of all filters
getFilters() : array
| since |
3.0 |
|---|
Response
array
render
Render the sidebar.
render() : string
| 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
| since |
3.0 |
|---|
Arguments
- $action
stringValue for the action attribute of the form
Properties
entries
Menu entries
| since |
3.0 |
|---|
Type(s)
array
filters
Filters
| since |
3.0 |
|---|
Type(s)
array
action
Value for the action attribute of the form.
| since |
3.0 |
|---|
Type(s)
string