API16

JModel/addIncludePath: Difference between revisions

From Joomla! Documentation

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




{{subst:Description:JModel/addIncludePath}}
 


===Syntax===
===Syntax===
Line 46: Line 46:




{{subst:SeeAlso:JModel/addIncludePath}}
 


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

Latest revision as of 01:54, 25 March 2017

Description

Add a directory where JModel should search for models. You may either pass a string or an array of directories.



Syntax

static addIncludePath($path='')
Parameter Name Default Value Description
$path A path to search.

Returns

array An array with directory elements

Defined in

libraries/joomla/application/component/model.php

Importing

jimport( 'joomla.application.component.model' );

Source Body

public static function addIncludePath($path='')
{
        static $paths;

        if (!isset($paths)) {
                $paths = array();
        }
        if (!empty($path) && !in_array($path, $paths)) {
                jimport('joomla.filesystem.path');
                array_unshift($paths, JPath::clean($path));
        }
        return $paths;
}



Examples

Code Examples