Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JModuleHelper

Description
Description | Methods (details)

Module helper class

  • since: 1.5

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

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, [string $title = null])
Method array &getModules (string $position)
Method boolean isEnabled (string $module)
Method void renderModule ( $module, [ $attribs = array()])
Methods
Description | Methods (details)
getLayoutPath (line 233)

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 $title = null])
  • string $name: The name of the module
  • string $title: The title of the module, optional
getModules (line 83)

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 115)

Checks if a module is enabled

  • access: public
boolean isEnabled (string $module)
  • string $module: The module name
renderModule (line 121)
void renderModule ( $module, [ $attribs = array()])
  • $module
  • $attribs
Documentation generated on Sat, 14 Nov 2009 11:14:32 +0000 by phpDocumentor 1.3.1