Class JModuleHelper

Description

Module helper class

  • abstract:
  • since: 11.1

Located in /libraries/joomla/application/module/helper.php (line 21)


	
			
Method Summary
static string getLayoutPath (string $module, [string $layout = 'default'])
static object The &getModule (string $name, [string $title = null])
static array &getModules (string $position)
static boolean isEnabled (string $module)
static string moduleCache (object $module, object $moduleparams, object $cacheparams)
static string renderModule (object $module, [array $attribs = array()])
static array &_load ()
Methods
static method getLayoutPath (line 248)

Get the path to a layout for a module

  • return: The path to the module layout
  • since: 11.1
  • access: public
static string getLayoutPath (string $module, [string $layout = 'default'])
  • string $module: The name of the module
  • string $layout: The name of the module layout. If alternative layout, in the form template:filename.
static method getModule (line 33)

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

  • return: Module object
  • since: 11.1
  • access: public
static object The &getModule (string $name, [string $title = null])
  • string $name: The name of the module
  • string $title: The title of the module, optional
static method getModules (line 81)

Get modules by position

  • return: An array of module objects
  • since: 11.1
  • access: public
static array &getModules (string $position)
  • string $position: The position of the module
static method isEnabled (line 120)

Checks if a module is enabled

  • since: 11.1
  • access: public
static boolean isEnabled (string $module)
  • string $module: The module name
static method moduleCache (line 423)

Module cache helper

Caching modes: To be set in XML: 'static' One cache file for all pages with the same module parameters 'oldstatic' 1.5 definition of module caching, one cache file for all pages with the same module id and user aid, '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

static string moduleCache (object $module, object $moduleparams, object $cacheparams)
  • object $module: Module object
  • object $moduleparams: Module parameters
  • object $cacheparams: Module cache parameters - id or url parameters, depending on the module cache mode
static method renderModule (line 137)

Render the module.

  • return: The HTML content of the module output.
  • since: 11.1
  • access: public
static string renderModule (object $module, [array $attribs = array()])
  • object $module: A module object.
  • array $attribs: An array of attributes for the module (probably from the XML).
static method _load (line 289)

Load published modules.

  • since: 11.1
  • access: protected
static array &_load ()

Documentation generated on Mon, 25 Jun 2012 13:55:27 -0500 by phpDocumentor 1.4.4