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 ModuleHelper

Fonctions membres publiques statiques

static & getModule ($name, $title=null)
 
static & getModules ($position)
 
static isEnabled ($module)
 
static renderModule ($module, $attribs=array())
 
static getLayoutPath ($module, $layout='default')
 
static cleanModuleList ($modules)
 
static isAdminMultilang ()
 

Fonctions membres protégées statiques

static & _load ()
 
static & load ()
 

Description détaillée

Module helper class

Depuis
1.5

Documentation des fonctions membres

◆ _load()

static& _load ( )
staticprotected

Load published modules.

Renvoie
array
Depuis
1.5
Obsolète:
4.0 Use ModuleHelper::load() instead

◆ cleanModuleList()

static cleanModuleList (   $modules)
static

Clean the module list

Paramètres
array$modulesArray with module objects
Renvoie
array

Références $i, $module, $modules, et null.

◆ getLayoutPath()

static getLayoutPath (   $module,
  $layout = 'default' 
)
static

Get the path to a layout for a module

Paramètres
string$moduleThe name of the module
string$layoutThe name of the module layout. If alternative layout, in the form template:filename.
Renvoie
string The path to the module layout
Depuis
1.5

Références $layout, $module, $template, JPATH_BASE, et JPATH_THEMES.

◆ getModule()

static& getModule (   $name,
  $title = null 
)
static

Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')

Paramètres
string$nameThe name of the module
string$titleThe title of the module, optional
Renvoie
The Module object
Depuis
1.5

Références $i, $modules, $name, $title, $total, name, null, et title.

Référencé par ModuleRenderer\render().

◆ getModules()

static& getModules (   $position)
static

Get modules by position

Paramètres
string$positionThe position of the module
Renvoie
array An array of module objects
Depuis
1.5

Références $i, $input, $modules, $position, $total, et ComponentHelper\getParams().

Référencé par HtmlDocument\countModules(), et ModulesRenderer\render().

◆ isAdminMultilang()

static isAdminMultilang ( )
static

Method to determine if filtering by language is enabled in back-end for modules.

Renvoie
boolean True if enabled; false otherwise.
Depuis
3.8.0

Références $enabled, LanguageHelper\getInstalledLanguages(), et ComponentHelper\getParams().

◆ isEnabled()

static isEnabled (   $module)
static

Checks if a module is enabled. A given module will only be returned if it meets the following criteria: it is enabled, it is assigned to the current menu item or all items, and the user meets the access level requirements.

Paramètres
string$moduleThe module name
Renvoie
boolean See description for conditions.
Depuis
1.5

Références $module, et null.

◆ load()

static& load ( )
staticprotected

Load published modules.

Renvoie
array
Depuis
3.2

Références $app, $modules, et null.

◆ renderModule()

static renderModule (   $module,
  $attribs = array() 
)
static

Render the module.

Paramètres
object$moduleA module object.
array$attribsAn array of attributes for the module (probably from the XML).
Renvoie
string The HTML content of the module output.
Depuis
1.5

Références $app, $attribs, $content, $lang, $module, $params, $path, $style, $template, ComponentHelper\getParams(), JDEBUG, JPATH_BASE, JPATH_THEMES, et null.

Référencé par ModuleRenderer\render().


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