Actions

API16

JTable/getInstance

From Joomla! Documentation

< API16:JTable
Revision as of 17:41, 22 March 2010 by Doxiki (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

Static method to get an instance of a JTable class if it can be found in the table include paths. To add include paths for searching for JTable classes JTable::addIncludePath().


[Edit Descripton]

Description:JTable/getInstance

Syntax

static getInstance($type, $prefix= 'JTable', $config=array())
Parameter Name Default Value Description
$type The type (name) of the class to get an instance of.
$prefix An optional prefix for the table class name.
$config array() An optional array of configuration values for the object.

Returns

mixed A object if found or boolean false if one could not be found.

Defined in

libraries/joomla/database/table.php

Importing

jimport( 'joomla.database.table' );

Source Body

public static function getInstance($type, $prefix = 'JTable', $config = array())
{
        // Sanitize and prepare the table class name.
        $type = preg_replace('/[^A-Z0-9_\.-]/i', '', $type);
        $tableClass = $prefix.ucfirst($type);
 
        // Only try to load the class if it doesn't already exist.
        if (!class_exists($tableClass)) {
                // Search for the class file in the JTable include paths.
                jimport('joomla.filesystem.path');
                if ($path = JPath::find(JTable::addIncludePath(), strtolower($type).'.php')) {
                        // Import the class file.
                        require_once $path;
 
                        // If we were unable to load the proper class, raise a warning and return false.
                        if (!class_exists($tableClass)) {
                                JError::raiseWarning(0, 'Table class ' . $tableClass . ' not found in file.');
                                return false;
                        }
                } else {
                        // If we were unable to find the class file in the JTable include paths, raise a warning and return false.
                        JError::raiseWarning(0, 'Table ' . $type . ' not supported. File not found.');
                        return false;
                }
        }
 
        // If a database object was passed in the configuration array use it, otherwise get the global one from JFactory.
        if (array_key_exists('dbo', $config)) {
                $db = &$config['dbo'];
        } else {
                $db = & JFactory::getDbo();
        }
 
        // Instantiate a new table class and return it.
        return new $tableClass($db);
}

[Edit See Also] SeeAlso:JTable/getInstance

Examples

<CodeExamplesForm />

getInstance example

 
$row =& JTable::getInstance('review', 'Table');
geomaras 00:35, 20 July 2010 (CDT) Edit comment