JView/loadHelper: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Load a helper file
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki>
</span>
... |
No edit summary |
||
| Line 32: | Line 32: | ||
===Source Body=== | ===Source Body=== | ||
<source lang="php"> | <source lang="php"> | ||
function loadHelper($hlp = null) | function loadHelper( $hlp = null) | ||
{ | { | ||
// clean the file name | // clean the file name | ||
Revision as of 22:10, 22 March 2010
Description
Load a helper file
Template:Description:JView/loadHelper
Syntax
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
boolean Returns true if the file was loaded
Defined in
libraries/joomla/application/component/view.php
Importing
jimport( 'joomla.application.component.view' );
Source Body
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
<CodeExamplesForm />