Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.

Class JModuleHelper

Description
Description | Methods (details)

Module helper class

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

Class JModuleHelper   (Subpackage Application)
Method Summary
Description | Methods (details)
Static method static string getLayoutPath (string $module, [string $layout = 'default'])
Method object The &getModule (string $name)
Method array &getModules (string $position)
Method boolean isEnabled (string $module)
Method void renderModule ( $module, [ $attribs = array()])
Methods
Description | Methods (details)
getLayoutPath (line 219)

Get the path to a layout for a module

  • return: The path to the module layout
  • since: 1.5
string getLayoutPath (string $module, [string $layout = 'default'])
  • string $module: The name of the module
  • string $layout: The name of the module layout
getModule (line 39)

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

  • return: Module object
  • access: public
object The &getModule (string $name)
  • string $name: The name of the module
getModules (line 77)

Get modules by position

  • return: An array of module objects
  • access: public
array &getModules (string $position)
  • string $position: The position of the module
isEnabled (line 101)

Checks if a module is enabled

  • access: public
boolean isEnabled (string $module)
  • string $module: The module name
renderModule (line 107)
void renderModule ( $module, [ $attribs = array()])
  • $module
  • $attribs
Documentation generated on Tue, 29 Jan 2008 18:47:31 +0000 by phpDocumentor 1.3.1