JHtmlSidebar

class JHtmlSidebar

Utility class to render a list view sidebar

Methods

static string

render()

Render the sidebar.

static void

addEntry( string $name, string $link = '', bool $active = false)

Method to add a menu item to submenu.

static array

getEntries()

Returns an array of all submenu entries

static void

addFilter( string $label, string $name, string $options, bool $noDefault = false)

Method to add a filter to the submenu

static array

getFilters()

Returns an array of all filters

static void

setAction( string $action)

Set value for the action attribute of the filter form

static string

getAction()

Get value for the action attribute of the filter form

Details

`static string render()`

Render the sidebar.

Return Value

string

The necessary HTML to display the sidebar

`static void addEntry( string $name, string $link = '', bool $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.

Return Value

void

`static array getEntries()`

Returns an array of all submenu entries

Return Value

array

`static void addFilter( string $label, string $name, string $options, bool $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 the label as the empty option

Return Value

void

`static array getFilters()`

Returns an array of all filters

Return Value

array

`static void setAction( string $action)`

Set value for the action attribute of the filter form

Parameters

string

$action

Value for the action attribute of the form

Return Value

void

`static string getAction()`

Get value for the action attribute of the filter form

Return Value

string