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	$name	Name of the menu item.
string	$link	URL of the menu item.
bool	$active	True 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(), PrivacyHelper\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	$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 show the label as the empty option

Renvoie

void

Depuis

3.0

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

Référencé par 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()

static render ( )

static

Render the sidebar.

Renvoie

string The necessary HTML to display the sidebar

Depuis

3.0

Références $data, et $layout.

Référencé par InstallerViewDefault\addToolbar(), LanguagesViewOverrides\addToolbar(), TemplatesViewTemplates\addToolbar(), LanguagesViewInstalled\addToolbar(), ModulesViewModules\addToolbar(), CacheViewPurge\display(), MediaViewMedia\display(), LanguagesViewLanguages\display(), TemplatesViewStyles\display(), CacheViewCache\display(), MenusViewItems\display(), MenusViewMenus\display(), BannersViewClients\display(), BannersViewTracks\display(), UsersViewLevels\display(), UsersViewGroups\display(), NewsfeedsViewNewsfeeds\display(), PrivacyViewCapabilities\display(), BannersViewBanners\display(), UsersViewNotes\display(), CheckinViewCheckin\display(), ContactViewContacts\display(), FieldsViewFields\display(), FieldsViewGroups\display(), FinderViewFilters\display(), FinderViewMaps\display(), CategoriesViewCategories\display(), ContentViewFeatured\display(), ContentViewArticles\display(), PrivacyViewConsents\display(), UsersViewUsers\display(), FinderViewIndex\display(), PrivacyViewRequests\display(), et FOFRenderStrapper\renderFormBrowse().

setAction()

static setAction (   $action )

static

Set value for the action attribute of the filter form

Paramètres

string

$action

Value for the action attribute of the form

Renvoie

void

Depuis

3.0

Références $action.

Référencé par InstallerViewDiscover\addToolbar(), LanguagesViewLanguages\addToolbar(), TemplatesViewStyles\addToolbar(), CacheViewCache\addToolbar(), InstallerViewManage\addToolbar(), InstallerViewUpdatesites\addToolbar(), BannersViewTracks\addToolbar(), InstallerViewUpdate\addToolbar(), LanguagesViewOverrides\addToolbar(), TemplatesViewTemplates\addToolbar(), UsersViewNotes\addToolbar(), ContactViewContacts\addToolbar(), AssociationsViewAssociation\addToolbar(), et FOFRenderStrapper\renderFormBrowse().

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 :

• sidebar.php