Difference between revisions of "JModuleHelper"

Latest revision as of 22:28, 24 March 2017

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JModuleHelper[edit]

Description[edit]

JModuleHelper is a static helper class which provides functionality to handle modules.

Methods[edit]

Visibility	Method name	Description
public static	getLayoutPath	Get the path to a layout for a module.
public	getModule	Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs').
public	getModules	Get modules by position.
public static	isEnabled	Checks if a module is enabled.
public static	moduleCache	Module cache helper.
public static	renderModule	Render the module.
protected	_load	Load published modules.

Defined in libraries/joomla/application/module/helper.php

Importing[edit]

jimport( 'joomla.application.module.helper' );

User contributed notes[edit]

Code Examples[edit]

@@ Line 1: / Line 1: @@
 __NOTOC__
-<span class="editsection" style="font-size:76%;">
+=={{JVer|11.1}} JModuleHelper==
-<nowiki>[</nowiki>[[Description:JModuleHelper|Edit Descripton]]<nowiki>]</nowiki>
+===Description===
-</span>
+[[JModuleHelper]] is a static helper class which provides functionality to handle modules.
-{{Description:JModuleHelper}}
-===Defined in===
-libraries/joomla/application/module/helper.php
-* see source code in [[jplatform:application/module/helper.php|BitBucket]]
-===Subpackage===
-[[Subpackage Application/11.1|Application]]
-===Extends===
-===Extended by===
 ===Methods===
 {| class="wikitable sortable"
 |-
+!Visibility
 !Method name
 !Description
 |-
-|[[JModuleHelper::getLayoutPath/11.1|getLayoutPath]]
+|public static
+|[[API17:JModuleHelper::getLayoutPath|getLayoutPath]]
 |Get the path to a layout for a module.
 |-
-|[[JModuleHelper::getModule/11.1|getModule]]
+|public
+|[[API17:JModuleHelper::getModule|getModule]]
 |Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs').
 |-
-|[[JModuleHelper::getModules/11.1|getModules]]
+|public
+|[[API17:JModuleHelper::getModules|getModules]]
 |Get modules by position.
 |-
-|[[JModuleHelper::isEnabled/11.1|isEnabled]]
+|public static
+|[[API17:JModuleHelper::isEnabled|isEnabled]]
 |Checks if a module is enabled.
 |-
-|[[JModuleHelper::moduleCache/11.1|moduleCache]]
+|public static
+|[[API17:JModuleHelper::moduleCache|moduleCache]]
 |Module cache helper.
 |-
-|[[JModuleHelper::renderModule/11.1|renderModule]]
+|public static
+|[[API17:JModuleHelper::renderModule|renderModule]]
 |Render the module.
 |-
-|[[JModuleHelper::_load/11.1|_load]]
+|protected
+|[[API17:JModuleHelper::_load|_load]]
 |Load published modules.
 |-
 |}
+* '''Defined in''' libraries/joomla/application/module/helper.php
 ===Importing===
 <source lang="php">jimport( 'joomla.application.module.helper' );</source>
 ===See also===
-* JModuleHelper source code in [[jplatform:application/module/helper.php|BitBucket]]
+* {{JVer|11.1}} '''JModuleHelper source code''' on [[jplatform:application/module/helper.php|BitBucket]]
-* [[JModuleHelper|Other versions of this class]]
+* {{JVer|11.1}} Subpackage [[API17:Subpackage Application|Application]]
-{{SeeAlso:JModuleHelper}}
+* [[API17:JModuleHelper|Other versions of JModuleHelper]]
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[SeeAlso:JModuleHelper|Edit See Also]]<nowiki>]</nowiki>
-</span>
+===User contributed notes===
-===Examples===
+=== Code Examples ===
-<CodeExamplesForm />
 <dpl>
 noresultsheader=\n
 category=JModuleHelper
-category=CodeExample
+namespace=CodeExample
 category=ClassExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
-<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JModuleHelper]]</noinclude>
+<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

API17