Actions

API16

JView/loadHelper

From Joomla! Documentation

< API16:JView
Replacement filing cabinet.png
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.

Contents

Description

Load a helper file

[Edit Descripton]

Description:JView/loadHelper

Syntax

loadHelper($hlp=null)
Parameter Name Default Value Description
$hlp null 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] SeeAlso:JView/loadHelper

Examples

<CodeExamplesForm />