API15:JModuleHelper/getModule

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')

Syntax

& getModule($name, $title=null)

Parameter Name	Default Value	Description
$name		$name The name of the module
$title	null	$title The title of the module, optional

Returns

object The Module object

Defined in

libraries/joomla/application/module/helper.php

Importing

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

Source Body

function &getModule($name, $title = null )
{
        $result         = null;
        $modules        =& JModuleHelper::_load();
        $total          = count($modules);
        for ($i = 0; $i < $total; $i++)
        {
                // Match the name of the module
                if ($modules[$i]->name == $name)
                {
                        // Match the title if we're looking for a specific instance of the module
                        if ( ! $title || $modules[$i]->title == $title )
                        {
                                $result =& $modules[$i];
                                break;  // Found it
                        }
                }
        }
 
        // if we didn't find it, and the name is mod_something, create a dummy object
        if (is_null( $result ) && substr( $name, 0, 4 ) == 'mod_')
        {
                $result                         = new stdClass;
                $result->id                     = 0;
                $result->title          = '';
                $result->module         = $name;
                $result->position       = '';
                $result->content        = '';
                $result->showtitle      = 0;
                $result->control        = '';
                $result->params         = '';
                $result->user           = 0;
        }
 
        return $result;
}

Examples

<CodeExamplesForm />