PHPXRef 0.7.1 : Joomla 2.5.4 DE : Detail view of helper.php

(no description)

Copyright:	Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License:	GNU General Public License version 2 or later; see LICENSE
File Size:	520 lines (14 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 7 functions

  getModule()
  getModules()
  isEnabled()
  renderModule()
  getLayoutPath()
  _load()
  moduleCache()

Functions

Functions that are not part of a class:

getModule($name, $title = null) X-Ref

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

param: string  $name   The name of the module
param: string  $title  The title of the module, optional
return: object  The Module object

getModules($position) X-Ref

Get modules by position

param: string $position The position of the module
return: array An array of module objects

isEnabled($module) X-Ref

Checks if a module is enabled

param: string $module The module name
return: boolean

renderModule($module, $attribs = array() X-Ref

Render the module.

param: object  $module   A module object.
param: array   $attribs  An array of attributes for the module (probably from the XML).
return: string  The HTML content of the module output.

getLayoutPath($module, $layout = 'default') X-Ref

Get the path to a layout for a module

param: string  $module  The name of the module
param: string  $layout  The name of the module layout. If alternative layout, in the form template:filename.
return: string  The path to the module layout

_load() X-Ref

Load published modules.

return: array

moduleCache($module, $moduleparams, $cacheparams) X-Ref

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

param: object  $module        Module object
param: object  $moduleparams  Module parameters
param: object  $cacheparams   Module cache parameters - id or url parameters, depending on the module cache mode
return: string

PHP Cross Reference of Joomla 2.5.4 DE

/libraries/joomla/application/module/ -> helper.php (summary)

Defines 7 functions