API17:JModuleHelper
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
m (→User contributed notes: bad link repair) |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JModuleHelper== | ||
| + | ===Description=== | ||
| + | {{Description:JModuleHelper}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JModuleHelper|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JModuleHelper|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public static | ||
|[[JModuleHelper::getLayoutPath/11.1|getLayoutPath]] | |[[JModuleHelper::getLayoutPath/11.1|getLayoutPath]] | ||
|Get the path to a layout for a module. | |Get the path to a layout for a module. | ||
|- | |- | ||
| + | |public | ||
|[[JModuleHelper::getModule/11.1|getModule]] | |[[JModuleHelper::getModule/11.1|getModule]] | ||
|Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs'). | |Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs'). | ||
|- | |- | ||
| + | |public | ||
|[[JModuleHelper::getModules/11.1|getModules]] | |[[JModuleHelper::getModules/11.1|getModules]] | ||
|Get modules by position. | |Get modules by position. | ||
|- | |- | ||
| + | |public static | ||
|[[JModuleHelper::isEnabled/11.1|isEnabled]] | |[[JModuleHelper::isEnabled/11.1|isEnabled]] | ||
|Checks if a module is enabled. | |Checks if a module is enabled. | ||
|- | |- | ||
| + | |public static | ||
|[[JModuleHelper::moduleCache/11.1|moduleCache]] | |[[JModuleHelper::moduleCache/11.1|moduleCache]] | ||
|Module cache helper. | |Module cache helper. | ||
|- | |- | ||
| + | |public static | ||
|[[JModuleHelper::renderModule/11.1|renderModule]] | |[[JModuleHelper::renderModule/11.1|renderModule]] | ||
|Render the module. | |Render the module. | ||
|- | |- | ||
| + | |protected | ||
|[[JModuleHelper::_load/11.1|_load]] | |[[JModuleHelper::_load/11.1|_load]] | ||
|Load published modules. | |Load published modules. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/application/module/helper.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.application.module.helper' );</source> | <source lang="php">jimport( 'joomla.application.module.helper' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JModuleHelper source code | + | * {{JVer|11.1}} '''JModuleHelper source code''' on [[jplatform:application/module/helper.php|BitBucket]] |
| − | * [[JModuleHelper|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]] |
| + | * [[JModuleHelper|Other versions of JModuleHelper]] | ||
{{SeeAlso:JModuleHelper}} | {{SeeAlso:JModuleHelper}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JModuleHelper|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JModuleHelper|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 56: | Line 61: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JModuleHelper]]</noinclude> | + | <noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JModuleHelper]]</noinclude> |
Revision as of 13:58, 29 August 2012
JModuleHelper
Description
JModuleHelper is a static helper class which provides functionality to handle modules. [Edit Descripton]
Methods
| 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
jimport( 'joomla.application.module.helper' );
See also
- JModuleHelper source code on BitBucket
- Subpackage Application
- Other versions of JModuleHelper
SeeAlso:JModuleHelper [Edit See Also]
User contributed notes
<CodeExamplesForm />
