Sidebar
Utility class to render a list view sidebar
since |
3.0 |
---|---|
package |
Joomla CMS |
Methods
addEntry
Method to add a menu item to submenu.
addEntry( name, link = '', active = false) :
since |
3.0 |
---|
Arguments
- name
string
Name of the menu item.- link
string
URL of the menu item.- active
bool
True if the item is active, false otherwise.
Response
void
addFilter
Method to add a filter to the submenu
addFilter( label, name, options, noDefault = false) :
since |
3.0 |
---|
Arguments
- label
string
Label for the menu item.- name
string
Name for the filter. Also used as id.- options
string
Options for the select field.- noDefault
bool
Don't show the label as the empty option
Response
void
getAction
Get value for the action attribute of the filter form
getAction() :
since |
3.0 |
---|
Response
string
getEntries
Returns an array of all submenu entries
getEntries() : mixed||string|int
since |
3.0 |
---|
Response
array<string|int, mixed>
getFilters
Returns an array of all filters
getFilters() : mixed||string|int
since |
3.0 |
---|
Response
array<string|int, mixed>
render
Render the sidebar.
render() :
since |
3.0 |
---|
Response
string
The necessary HTML to display the sidebar
setAction
Set value for the action attribute of the filter form
setAction( action) :
since |
3.0 |
---|
Arguments
- action
string
Value for the action attribute of the form
Response
void
Properties
entries
Menu entries
since |
3.0 |
---|
Type(s)
array<string|int, mixed>
filters
Filters
since |
3.0 |
---|
Type(s)
array<string|int, mixed>
action
Value for the action attribute of the form.
since |
3.0 |
---|
Type(s)
string