JView/loadHelper: Difference between revisions

Revision as of 18:59, 12 May 2013

Description

Load a helper file

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

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;
        }
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

@@ Line 3: / Line 3: @@
 <span class="editsection" style="font-size:76%;">
-	<nowiki>[</nowiki>[[Description:JView/loadHelper|Edit Descripton]]<nowiki>]</nowiki>
+	<nowiki>[<! removed edit link to red link >]</nowiki>
 </span>
-{{Description:JView/loadHelper}}
+<! removed transcluded page call, red link never existed >
 ===Syntax===
@@ Line 50: / Line 50: @@
 <span class="editsection" style="font-size:76%;">
-	<nowiki>[</nowiki>[[SeeAlso:JView/loadHelper|Edit See Also]]<nowiki>]</nowiki>
+	<nowiki>[<! removed edit link to red link >]</nowiki>
 </span>
-{{SeeAlso:JView/loadHelper}}
+<! removed transcluded page call, red link never existed >
 ===Examples===
@@ Line 65: / Line 65: @@
   format= ,,,
 </dpl>
+[[Category:Archived pages API15]]

API15