API16

JParameter/addElementPath: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JParameter/addElementPath}}
 


===Syntax===
===Syntax===
Line 50: Line 50:




{{subst:SeeAlso:JParameter/addElementPath}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=addElementPath
  category=addElementPath
  category=JParameter
  category=JParameter
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 01:57, 25 March 2017

Description

Add a directory where JParameter should search for element types.



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

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



Examples

Code Examples