API15

JModuleHelper/getModules: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
New page: ===Description=== Get modules by position <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki...
 
Doxiki (talk | contribs)
No edit summary
Line 9: Line 9:


===Syntax===
===Syntax===
<source lang="php">static& getModules($position)</source>
<source lang="php">& getModules($position)</source>


  {| class="wikitable"
  {| class="wikitable"
Line 19: Line 19:
| $position
| $position
|  
|  
|  $position The position of the module
|  $position The position of the module  
|}
|}


Line 32: Line 32:
===Source Body===
===Source Body===
<source lang="php">
<source lang="php">
public static function &getModules($position)
function &getModules($position)
{
{
        $app            = &JFactory::getApplication();
         $position      = strtolower( $position );
         $position      = strtolower($position);
         $result        = array();
         $result        = array();


         $modules = &JModuleHelper::_load();
         $modules =& JModuleHelper::_load();


         $total = count($modules);
         $total = count($modules);
         for ($i = 0; $i < $total; $i++)
         for($i = 0; $i < $total; $i++) {
        {
                 if($modules[$i]->position == $position) {
                 if ($modules[$i]->position == $position) {
                         $result[] =& $modules[$i];
                         $result[] = &$modules[$i];
                 }
                 }
         }
         }
         if (count($result) == 0)
         if(count($result) == 0) {
        {
                 if(JRequest::getBool('tp')) {
                 if ($app->getCfg('debug_modules') && JRequest::getBool('tp'))
                         $result[0] = JModuleHelper::getModule( 'mod_'.$position );
                {
                         $result[0] = JModuleHelper::getModule('mod_'.$position);
                         $result[0]->title = $position;
                         $result[0]->title = $position;
                         $result[0]->content = $position;
                         $result[0]->content = $position;

Revision as of 22:09, 22 March 2010

Description

Get modules by position

[Edit Descripton]

Template:Description:JModuleHelper/getModules

Syntax

& getModules($position)
Parameter Name Default Value Description
$position $position The position of the module

Returns

array An array of module objects

Defined in

libraries/joomla/application/module/helper.php

Importing

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

Source Body

function &getModules($position)
{
        $position       = strtolower( $position );
        $result         = array();

        $modules =& JModuleHelper::_load();

        $total = count($modules);
        for($i = 0; $i < $total; $i++) {
                if($modules[$i]->position == $position) {
                        $result[] =& $modules[$i];
                }
        }
        if(count($result) == 0) {
                if(JRequest::getBool('tp')) {
                        $result[0] = JModuleHelper::getModule( 'mod_'.$position );
                        $result[0]->title = $position;
                        $result[0]->content = $position;
                        $result[0]->position = $position;
                }
        }

        return $result;
}

[Edit See Also] Template:SeeAlso:JModuleHelper/getModules

Examples

<CodeExamplesForm />