API15

JView/loadHelper

From Joomla! Documentation

< API15:JView
Revision as of 16:53, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Load a helper file <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </span> ...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Load a helper file

[Edit Descripton]

Template:Description:JView/loadHelper

Syntax[edit]

loadHelper($hlp=null)
Parameter Name Default Value Description
$hlp null $tpl The name of the helper source file ... automatically searches the helper paths and compiles as needed.

Returns[edit]

boolean Returns true if the file was loaded

Defined in[edit]

libraries/joomla/application/component/view.php

Importing[edit]

jimport( 'joomla.application.component.view' );

Source Body[edit]

function loadHelper($hlp = null)
{
        // clean the file name
        $file = preg_replace('/[^A-Z0-9_\.-]/i', '', $hlp);

        // load the template script
        jimport('joomla.filesystem.path');
        $helper = JPath::find($this->_path['helper'], $this->_createFileName('helper', array('name' => $file)));

        if ($helper != false)
        {
                // include the requested template filename in the local scope
                include_once $helper;
        }
}

[Edit See Also] Template:SeeAlso:JView/loadHelper

Examples[edit]

<CodeExamplesForm />