Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JAdminCssMenu

Fonctions membres publiques

 __construct (User $user=null)
 
 getTree ()
 
 load ($params, $enabled)
 
 renderSubmenu ($layoutFile)
 

Fonctions membres protégées

 check ($items, Registry $params)
 
 preprocess ($items)
 
 populateTree ($levels)
 

Attributs protégés

 $tree
 
 $params
 
 $enabled
 
 $user
 

Description détaillée

Tree based class to render the admin menu

Depuis
1.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( User  $user = null)

JAdminCssMenu constructor.

Paramètres
User | null$userThe current user
Depuis
3.9.1

Références $user, Log\add(), Factory\getUser(), null, et Log\WARNING.

Documentation des fonctions membres

◆ check()

check (   $items,
Registry  $params 
)
protected

Check the flat list of menu items for important links

Paramètres
array$itemsThe menu items array
Registry$paramsModule options
Renvoie
boolean Whether to show recovery menu
Depuis
3.8.0

Références $app, $items, $message, $params, $uri, et ArrayHelper\getColumn().

◆ getTree()

getTree ( )

Get the current menu tree

Renvoie
Tree
Depuis
3.8.0
Obsolète:
4.0

Références tree.

◆ load()

load (   $params,
  $enabled 
)

Populate the menu items in the menu tree object

Paramètres
Registry$paramsMenu configuration parameters
bool$enabledWhether the menu should be enabled or disabled
Renvoie
void
Depuis
3.7.0

Références $enabled, $items, $name, $params, $uri, MenusHelper\getMenuItems(), et tree.

◆ populateTree()

populateTree (   $levels)
protected

Load the menu items from a hierarchical list of items into the menu tree

Paramètres
stdClass[]$levels Menu items as a hierarchical list format
Renvoie
void
Depuis
3.8.0
Obsolète:
4.0

Références $class, $item, elseif, null, et tree.

◆ preprocess()

preprocess (   $items)
protected

Filter and perform other preparatory tasks for loaded menu items based on access rights and module configurations for display

Paramètres

Références $dispatcher, $i, $item, $items, $language, $query, elseif, JEventDispatcher\getInstance(), MenusHelper\getMenuItems(), JPATH_ADMINISTRATOR, null, et ArrayHelper\sortObjects().

◆ renderSubmenu()

renderSubmenu (   $layoutFile)

Method to render a given level of a menu using provided layout file

Paramètres
string$layoutFileThe layout file to be used to render
Renvoie
void
Depuis
3.8.0

Références tree.

Documentation des champs

◆ $enabled

$enabled
protected

◆ $params

$params
protected

◆ $tree

$tree
protected

◆ $user

$user
protected

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