API15

API15:JModuleHelper/getLayoutPath

From Joomla! Documentation

Revision as of 21:52, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Get the path to a layout for a module <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Get the path to a layout for a module

[Edit Descripton]

Template:Description:JModuleHelper/getLayoutPath

Syntax

static getLayoutPath($module, $layout= 'default')
Parameter Name Default Value Description
$module $module The name of the module
$layout 'default' $layout The name of the module layout

Returns

string The path to the module layout

Defined in

libraries/joomla/application/module/helper.php

Importing

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

Source Body

public static function getLayoutPath($module, $layout = 'default')
{
        $app = JFactory::getApplication();

        // Build the template and base path for the layout
        $tPath = JPATH_BASE.'/templates/'.$app->getTemplate().'/html/'.$module.'/'.$layout.'.php';
        $bPath = JPATH_BASE.'/modules/'.$module.'/tmpl/'.$layout.'.php';

        // If the template has a layout override use it
        if (file_exists($tPath)) {
                return $tPath;
        }
        else {
                return $bPath;
        }
}

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

Examples

<CodeExamplesForm />