ModuleHelper

Module helper class

abstract
since

1.5

Methods

cleanModuleList

Clean the module list

cleanModuleList(array $modules) : array
static

Arguments

$modules

arrayArray with module objects

Response

array

createDummyModule

Method to create a dummy module.

createDummyModule() : \stdClass
static
since

4.0.0

Response

\stdClassThe Module object

getLayoutPath

Get the path to a layout for a module

getLayoutPath(string $module, string $layout = 'default') : string
static
since

1.5

Arguments

$module

stringThe name of the module

$layout

stringThe name of the module layout. If alternative layout, in the form template:filename.

Response

stringThe path to the module layout

getModule

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

getModule(string $name, string $title = null) : \stdClass
static
since

1.5

Arguments

$name

stringThe name of the module

$title

stringThe title of the module, optional

Response

\stdClassThe Module object

getModuleById

Get module by id

getModuleById(string $id) : \stdClass
static
since

3.9.0

Arguments

$id

stringThe id of the module

Response

\stdClassThe Module object

getModuleList

Module list

getModuleList() : array
static

Response

array

getModules

Get modules by position

getModules(string $position) : array
static
since

1.5

Arguments

$position

stringThe position of the module

Response

arrayAn array of module objects

isAdminMultilang

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

isAdminMultilang() : boolean
static
since

3.8.0

Response

booleanTrue if enabled; false otherwise.

isEnabled

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.

isEnabled(string $module) : boolean
static
since

1.5

Arguments

$module

stringThe module name

Response

booleanSee description for conditions.

load

Load published modules.

load() : array
static
since

3.2

Response

array

moduleCache

Module cache helper

moduleCache(object $module, object $moduleparams, object $cacheparams) : string
static

Caching modes: To be set in XML: 'static' One cache file for all pages with the same module parameters 'itemid' Changes on itemid change, to be called from inside the module: 'safeuri' Id created from $cacheparams->modeparams array, 'id' Module sets own cache id's

see \Joomla\CMS\Filter\InputFilter::clean()
since

1.6

Arguments

$module

objectModule object

$moduleparams

objectModule parameters

$cacheparams

objectModule cache parameters - id or URL parameters, depending on the module cache mode

Response

string

renderModule

Render the module.

renderModule(object $module, array $attribs = array()) : string
static
since

1.5

Arguments

$module

objectA module object.

$attribs

arrayAn array of attributes for the module (probably from the XML).

Response

stringThe HTML content of the module output.

renderRawModule

Render the module content.

renderRawModule(object $module, \Joomla\Registry\Registry $params, array $attribs = array()) : string
static
since

4.0.0

Arguments

$module

objectA module object

$params

\Joomla\Registry\RegistryA module parameters

$attribs

arrayAn array of attributes for the module (probably from the XML).

Response

string