Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe AbstractMenu
+ Graphe d'héritage de AbstractMenu:

Fonctions membres publiques

 __construct ($options=array())
 
 setUser ($user)
 
 getItem ($id)
 
 setDefault ($id, $language=' *')
 
 getDefault ($language=' *')
 
 setActive ($id)
 
 getActive ()
 
 getItems ($attributes, $values, $firstonly=false)
 
 getParams ($id)
 
 getMenu ()
 
 authorise ($id)
 
 load ()
 
 __get ($propName)
 

Fonctions membres publiques statiques

static getInstance ($client, $options=array())
 

Attributs publics statiques

static $instances = array()
 

Fonctions membres protégées

 getUser ()
 

Attributs protégés

 $items = array()
 
 $default = array()
 
 $active = 0
 
 $storedUser
 

Attributs privés

 $itemsLoaded = false
 

Description détaillée

Menu class

Depuis
1.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = array())

Class constructor

Paramètres
array$optionsAn array of configuration options.
Depuis
1.5

It is preferred NOT to inject and store the user when constructing the menu object, at least for the Menu object used by Joomla. The menu object can be built very early in the request, from an onAfterInitialise event but the user can be updated later (by the Remember me plugin for instance). As the stored user object is not updated, the menu will render incorrectly, not complying with menu items access levels.

Voir également
https://github.com/joomla/joomla-cms/issues/11541

Références $options, et null.

Documentation des fonctions membres

◆ __get()

__get (   $propName)

Magic getter for the user object. Returns the injected one if any, or the current one if none.

Using a magic getter to preserve B/C when we stopped storing the user object upon construction of the menu object. As the user property is not initialized anymore, this getter ensures any class extending this one can still use $instance->user and get a proper value.

Paramètres
string$propNameName of the missing or protected property.
Renvoie
User|null
Depuis
3.9.26

Références Factory\getUser(), et null.

◆ authorise()

authorise (   $id)

Method to check Menu object authorization against an access control object and optionally an access extension object

Paramètres
integer$idThe menu id
Renvoie
boolean
Depuis
1.5

Références $id, $menu, et if.

◆ getActive()

getActive ( )

Get menu item by id.

Renvoie
MenuItem|void The item object if an active menu item has been set or null
Depuis
1.5

Références $active.

◆ getDefault()

getDefault (   $language = '*')

Get the default item by language code.

Paramètres
string$languageThe language code, default value of * means all.
Renvoie
MenuItem|void The item object or null when not found for given language
Depuis
1.5

Références $items, et $language.

◆ getInstance()

static getInstance (   $client,
  $options = array() 
)
static

Returns a Menu object

Paramètres
string$clientThe name of the client
array$optionsAn associative array of options
Renvoie
AbstractMenu A menu object.
Depuis
1.5
Exceptions

Références $client, $options, class, Factory\getContainer(), et Text\sprintf().

Référencé par RouteHelper\_findItem().

◆ getItem()

getItem (   $id)

Get menu item by id

Paramètres
integer$idThe item id
Renvoie
MenuItem|null The item object if the ID exists or null if not found
Depuis
1.5

Références $id, $result, et null.

◆ getItems()

getItems (   $attributes,
  $values,
  $firstonly = false 
)

Gets menu items by attribute

Paramètres
mixed$attributesThe field name(s).
mixed$valuesThe value(s) of the field. If an array, need to match field names each attribute may have multiple values to lookup for.
boolean$firstonlyIf true, only returns the first item found
Renvoie
MenuItem|MenuItem[] An array of menu item objects or a single object if the $firstonly parameter is true
Depuis
1.5

Références $attributes, $count, $i, $item, et $items.

◆ getMenu()

getMenu ( )

Getter for the menu array

Renvoie
MenuItem[]
Depuis
1.5

Références $item, $items, et items.

◆ getParams()

getParams (   $id)

Gets the parameter object for a certain menu item

Paramètres
integer$idThe item id
Renvoie
Registry
Depuis
1.5

Références $id, et $menu.

◆ getUser()

getUser ( )
protected

Internal getter for the user. Returns the injected one if any, or the current one if none.

Renvoie
User
Depuis
3.9.26

Références Factory\getUser().

◆ load()

load ( )
abstract

Loads the menu items

Renvoie
array
Depuis
1.5

◆ setActive()

setActive (   $id)

Set the default item by id

Paramètres
integer$idThe item id
Renvoie
MenuItem|void The menu item representing the given ID if present or null otherwise
Depuis
1.5

Références $id.

◆ setDefault()

setDefault (   $id,
  $language = '*' 
)

Set the default item by id and language code.

Paramètres
integer$idThe menu item id.
string$languageThe language code (since 1.6).
Renvoie
boolean True if a menu item with the given ID exists
Depuis
1.5

Références $id, et $language.

◆ setUser()

setUser (   $user)

Setter for the current user used to build menu.

Paramètres
User$userThe new user to set.
Renvoie
void
Depuis
3.9.26

Références $user.

Documentation des champs

◆ $active

$active = 0
protected

◆ $default

$default = array()
protected

◆ $instances

$instances = array()
static

Référencé par CMSApplication\getMenu().

◆ $items

$items = array()
protected

◆ $itemsLoaded

$itemsLoaded = false
private

◆ $storedUser

$storedUser
protected

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