JTable/addIncludePath

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

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

[<! removed edit link to red link >]

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

Syntax[edit]

addIncludePath($path=null)

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

Returns[edit]

array An array with directory elements

Defined in[edit]

libraries/joomla/database/table.php

Importing[edit]

jimport( 'joomla.database.table' );

Source Body[edit]

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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

Code Examples[edit]

API15