API16

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...
 
m preparing for archive only
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
Get modules by position
Get modules by position


<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JModuleHelper/getModules|Edit Descripton]]<nowiki>]</nowiki>
</span>


{{Description:JModuleHelper/getModules}}
 
 


===Syntax===
===Syntax===
Line 62: Line 60:
</source>
</source>


<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JModuleHelper/getModules|Edit See Also]]<nowiki>]</nowiki>
 
</span>
{{SeeAlso:JModuleHelper/getModules}}


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getModules
  category=getModules
  category=JModuleHelper
  category=JModuleHelper
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 01:55, 25 March 2017

Description

Get modules by position



Syntax

static& 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

public static function &getModules($position)
{
        $app            = &JFactory::getApplication();
        $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 ($app->getCfg('debug_modules') && JRequest::getBool('tp'))
                {
                        $result[0] = JModuleHelper::getModule('mod_'.$position);
                        $result[0]->title = $position;
                        $result[0]->content = $position;
                        $result[0]->position = $position;
                }
        }

        return $result;
}



Examples

Code Examples