Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
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 renderRawModule ($module, Registry $params, $attribs=array())
 
static getLayoutPath ($module, $layout='default')
 
static cleanModuleList ($modules)
 
static isAdminMultilang ()
 
static & getModuleById ($id)
 

Fonctions membres protégées statiques

static & load ()
 
static createDummyModule ()
 

Description détaillée

Module helper class

Depuis
1.5

Documentation des fonctions membres

◆ cleanModuleList()

static cleanModuleList (   $modules)
static

Clean the module list

Paramètres
array$modulesArray with module objects
Renvoie
array

Références $i, $module, $modules, Factory\getApplication(), et null.

◆ createDummyModule()

static createDummyModule ( )
staticprotected

Method to create a dummy module.

Renvoie
The Module object
Depuis
4.0.0

Références $module.

◆ 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, $temp, $template, Path\check(), Factory\getApplication(), 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, $result, $title, $total, name, et null.

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

◆ getModuleById()

static& getModuleById (   $id)
static

Get module by id

Paramètres
string$idThe id of the module
Renvoie
The Module object
Depuis
3.9.0

Références $i, $id, $modules, $result, et $total.

◆ 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, $result, $total, Factory\getApplication(), et ComponentHelper\getParams().

Référencé par HtmlDocument\countModules(), HtmlView\display(), 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, et ComponentHelper\getParams().

Référencé par HtmlView\display(), ModuleModel\getForm(), MenusModel\getMissingModuleLanguages(), et ListField\getOptions().

◆ 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, $result, et null.

◆ load()

static& load ( )
staticprotected

Load published modules.

Renvoie
array
Depuis
3.2

Références $app, $modules, Factory\getApplication(), 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, $basePath, $displayData, $module, $params, $scope, $style, $template, Log\addLogger(), Log\ALL, Factory\getApplication(), Profiler\getInstance(), ComponentHelper\getParams(), JDEBUG, JPATH_THEMES, null, et LayoutHelper\render().

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

◆ renderRawModule()

static renderRawModule (   $module,
Registry  $params,
  $attribs = array() 
)
static

Render the module content.

Paramètres
object$moduleA module object
Registry$paramsA module parameters
array$attribsAn array of attributes for the module (probably from the XML).
Renvoie
string
Depuis
4.0.0

Références $app, $module, $scope, Factory\getApplication(), Joomla\CMS\Application\getDispatcher(), Profiler\getInstance(), et JDEBUG.


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