Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JHtmlSidebar

Fonctions membres publiques statiques

static render ()
 
static addEntry ($name, $link='', $active=false)
 
static getEntries ()
 
static addFilter ($label, $name, $options, $noDefault=false)
 
static getFilters ()
 
static setAction ($action)
 
static getAction ()
 

Attributs protégés statiques

static $entries = array()
 
static $filters = array()
 
static $action = ''
 

Description détaillée

Utility class to render a list view sidebar

Depuis
3.0

Documentation des fonctions membres

◆ addEntry()

static addEntry (   $name,
  $link = '',
  $active = false 
)
static

Method to add a menu item to submenu.

Paramètres
string$nameName of the menu item.
string$linkURL of the menu item.
bool$activeTrue if the item is active, false otherwise.
Renvoie
void
Depuis
3.0

Références $active, $link, et $name.

Référencé par InstallerHelper\addSubmenu(), TemplatesHelper\addSubmenu(), MessagesHelper\addSubmenu(), NewsfeedsHelper\addSubmenu(), BannersHelper\addSubmenu(), ContactHelper\addSubmenu(), LanguagesHelper\addSubmenu(), ContentHelper\addSubmenu(), UsersHelper\addSubmenu(), FinderHelper\addSubmenu(), MenusHelper\addSubmenu(), CacheHelper\addSubmenu(), CheckinController\addSubmenu(), et FOFRenderStrapper\renderLinkbarItems().

◆ addFilter()

static addFilter (   $label,
  $name,
  $options,
  $noDefault = false 
)
static

Method to add a filter to the submenu

Paramètres
string$labelLabel for the menu item.
string$nameName for the filter. Also used as id.
string$optionsOptions for the select field.
bool$noDefaultDon't the label as the empty option
Renvoie
void
Depuis
3.0

Références $filters, $label, $name, et $options.

Référencé par LanguagesViewOverrides\addToolbar(), et FOFRenderStrapper\renderFormBrowse().

◆ getAction()

static getAction ( )
static

Get value for the action attribute of the filter form

Renvoie
string
Depuis
3.0

Références $action.

◆ getEntries()

static getEntries ( )
static

Returns an array of all submenu entries

Renvoie
array
Depuis
3.0

Référencé par ModulesViewModules\addToolbar(), et FOFRenderStrapper\postRender().

◆ getFilters()

static getFilters ( )
static

Returns an array of all filters

Renvoie
array
Depuis
3.0

Références $filters.

◆ render()

◆ setAction()

Documentation des champs

◆ $action

$action = ''
staticprotected

◆ $entries

$entries = array()
staticprotected

◆ $filters

$filters = array()
staticprotected

La documentation de cette classe a été générée à partir du fichier suivant :