Docs For Class JSubMenuHelper

Description

Utility class for the submenu.

deprecated: 4.0 Use JHtmlSidebar instead.
abstract:
since: 1.5

Located in /administrator/includes/toolbar.php (line 646)

Variable Summary

static string $action

static array $entries

static array $filters

Method Summary

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

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

static string getAction ()

static array getEntries ()

static array getFilters ()

static void setAction (string $action)

Variables

static string $action = '' (line 673)

Value for the action attribute of the form.

deprecated: 4.0
since: 3.0
access: protected

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

Menu entries

deprecated: 4.0
since: 3.0
access: protected

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

Filters

deprecated: 4.0
since: 3.0
access: protected

Methods

static addEntry (line 687)

Method to add a menu item to submenu.

deprecated: 4.0 Use JHtmlSidebar::addEntry() instead.
since: 1.5
access: public

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

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

static addFilter (line 720)

Method to add a filter to the submenu

deprecated: 4.0 Use JHtmlSidebar::addFilter() instead.
since: 3.0
access: public

static void addFilter (string $label, string $name, string $options, [boolean $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.
boolean $noDefault: Don't the label as the empty option

static getAction (line 764)

Get value for the action attribute of the filter form

return: Value for the action attribute of the form
deprecated: 4.0 Use JHtmlSidebar::getAction() instead.
since: 3.0
access: public

static string getAction ()

static getEntries (line 701)

Returns an array of all submenu entries

deprecated: 4.0 Use JHtmlSidebar::getEntries() instead.
since: 3.0
access: public

static array getEntries ()

static getFilters (line 734)

Returns an array of all filters

deprecated: 4.0 Use JHtmlSidebar::getFilters() instead.
since: 3.0
access: public

static array getFilters ()

static setAction (line 750)

Set value for the action attribute of the filter form

deprecated: 4.0 Use JHtmlSidebar::setAction() instead.
since: 3.0
access: public

static void setAction (string $action)

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