API15:JTable/addIncludePath

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.

Description

Add a directory where JTable should search for table types. You may either pass a string or an array of directories.

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

Syntax

addIncludePath($path=null)

Parameter Name	Default Value	Description
$path	null	A path to search.

Returns

array An array with directory elements

Defined in

libraries/joomla/database/table.php

Importing

jimport( 'joomla.database.table' );

Source Body

function addIncludePath( $path=null )
{
        static $paths;
 
        if (!isset($paths)) {
                $paths = array( dirname( __FILE__ ).DS.'table' );
        }
 
        // just force path to array
        settype($path, 'array');
 
        if (!empty( $path ) && !in_array( $path, $paths ))
        {
                // loop through the path directories
                foreach ($path as $dir)
                {
                        // no surrounding spaces allowed!
                        $dir = trim($dir);
 
                        // add to the top of the search dirs
                        // so that custom paths are searched before core paths
                        array_unshift($paths, $dir);
                }
        }
        return $paths;
}

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

Examples

<CodeExamplesForm />