Get the path to a layout for a module
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.
Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')
static
object The
&getModule
(string $name, [string $title = null])
-
string
$name: The name of the module
-
string
$title: The title of the module, optional
Get modules by position
static
array
&getModules
(string $position)
-
string
$position: The position of the module
Checks if a module is enabled
static
boolean
isEnabled
(string $module)
-
string
$module: The module name
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
Render the module.
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).
Load published modules.
static
array
&_load
()