Actions

API15

JParameter/addElementPath

From Joomla! Documentation

< API15:JParameter
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

Add a directory where JParameter should search for element types

[<! removed edit link to red link >]

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

Syntax

addElementPath($path)
Parameter Name Default Value Description
$path directory or directories to search.

Defined in

libraries/joomla/html/parameter.php

Importing

jimport( 'joomla.html.parameter' );

Source Body

function addElementPath( $path )
{
        // just force path to array
        settype( $path, 'array' );
 
        // loop through the path directories
        foreach ( $path as $dir )
        {
                // no surrounding spaces allowed!
                $dir = trim( $dir );
 
                // add trailing separators as needed
                if ( substr( $dir, -1 ) != DIRECTORY_SEPARATOR ) {
                        // directory
                        $dir .= DIRECTORY_SEPARATOR;
                }
 
                // add to the top of the search dirs
                array_unshift( $this->_elementPath, $dir );
        }
 
 
}

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

Examples

<CodeExamplesForm />