Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class ModuleHelper - list of methods

Module helper class
Package: Joomla\CMS\Helper
Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Helper/ModuleHelper.php
Project: Joomla

Method Summary

public static \stdClass
(mixed $name, mixed $title = null)

Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')
Parameters
  • string $name The name of the module
  • string $title The title of the module, optional
Returns
  • \stdClass The Module object
Since
  • 1.5
Show source code of this method: getModule Source Code

public static array
(mixed $position)

Get modules by position
Parameters
  • string $position The position of the module
Returns
  • array An array of module objects
Since
  • 1.5
Show source code of this method: getModules Source Code

public static bool
(mixed $module)

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.
Parameters
  • string $module The module name
Returns
  • bool See description for conditions.
Since
  • 1.5
Show source code of this method: isEnabled Source Code

public static string
(mixed $module, mixed $attribs = array())

Render the module.
Parameters
  • object $module A module object.
  • array $attribs An array of attributes for the module (probably from the XML).
Returns
  • string The HTML content of the module output.
Since
  • 1.5
Show source code of this method: renderModule Source Code

public static string
(mixed $module, \Joomla\Registry\Registry $params, mixed $attribs = array())

Render the module content.
Parameters
  • object $module A module object
  • \Joomla\Registry\Registry $params A module parameters
  • array $attribs An array of attributes for the module (probably from the XML).
Returns
  • string
Since
  • 4.0.0
Show source code of this method: renderRawModule Source Code

public static string
(mixed $module, mixed $layout = 'default')

Get the path to a layout for a module
Parameters
  • string $module The name of the module
  • string $layout The name of the module layout. If alternative layout, in the form template:filename.
Returns
  • string The path to the module layout
Since
  • 1.5
Show source code of this method: getLayoutPath Source Code

protected static array
()

Load published modules.
Returns
  • array
Since
  • 3.2
Show source code of this method: load Source Code

public static array
()

Module list
Returns
  • array
Show source code of this method: getModuleList Source Code

public static array
(mixed $modules)

Clean the module list
Parameters
  • array $modules Array with module objects
Returns
  • array
Show source code of this method: cleanModuleList Source Code

public static string
(mixed $module, mixed $moduleparams, mixed $cacheparams)

Module cache helper
Parameters
  • object $module Module object
  • object $moduleparams Module parameters
  • object $cacheparams Module cache parameters - id or URL parameters, depending on the module cache mode
Returns
  • string
Since
  • 1.6
-
  • \Joomla\CMS\Filter\InputFilter::clean()
Show source code of this method: moduleCache Source Code

public static bool
()

Method to determine if filtering by language is enabled in back-end for modules.
Returns
  • bool True if enabled; false otherwise.
Since
  • 3.8.0
Show source code of this method: isAdminMultilang Source Code

public static \stdClass
(mixed $id)

Get module by id
Parameters
  • string $id The id of the module
Returns
  • \stdClass The Module object
Since
  • 3.9.0
Show source code of this method: getModuleById Source Code

protected static \stdClass
()

Method to create a dummy module.
Returns
  • \stdClass The Module object
Since
  • 4.0.0
Show source code of this method: createDummyModule Source Code

Tags Summary

Since
1.5