Class JDatabaseFactory

Joomla Platform Database Factory class

Package: Joomla\Platform\Database
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.1
Located at joomla/database/factory.php

Methods summary

`public JDatabaseDriver`	# `getDriver( string $name = 'mysqli', array $options = array() )` Method to return a JDatabaseDriver instance based on the given options. There are three global options and then the rest are specific to the database driver. The 'database' option determines which database is to be used for the connection. The 'select' option determines whether the connector should automatically select the chosen database. Method to return a JDatabaseDriver instance based on the given options. There are three global options and then the rest are specific to the database driver. The 'database' option determines which database is to be used for the connection. The 'select' option determines whether the connector should automatically select the chosen database. Instances are unique to the given options and new objects are only created when a unique options array is passed into the method. This ensures that we don't end up with unnecessary database connection resources. Parameters `$name` `string` - $name Name of the database driver you'd like to instantiate `$options` `array` - $options Parameters to be passed to the database driver. Returns `JDatabaseDriver` - A database driver object. Throws `RuntimeException` Since 12.1
`public JDatabaseExporter`	# `getExporter( string $name, JDatabaseDriver $db = null )` Gets an exporter class object. Gets an exporter class object. Parameters `$name` `string` - $name Name of the driver you want an exporter for. `$db` `JDatabaseDriver` - $db Optional JDatabaseDriver instance Returns `JDatabaseExporter` - An exporter object. Throws `RuntimeException` Since 12.1
`public JDatabaseImporter`	# `getImporter( string $name, JDatabaseDriver $db = null )` Gets an importer class object. Gets an importer class object. Parameters `$name` `string` - $name Name of the driver you want an importer for. `$db` `JDatabaseDriver` - $db Optional JDatabaseDriver instance Returns `JDatabaseImporter` - An importer object. Throws `RuntimeException` Since 12.1
`public static JDatabaseFactory`	# `getInstance( )` Gets an instance of the factory object. Gets an instance of the factory object. Returns `JDatabaseFactory` Since 12.1
`public JDatabaseQuery`	# `getQuery( string $name, JDatabaseDriver $db = null )` Get the current query object or a new JDatabaseQuery object. Get the current query object or a new JDatabaseQuery object. Parameters `$name` `string` - $name Name of the driver you want an query object for. `$db` `JDatabaseDriver` - $db Optional JDatabaseDriver instance Returns `JDatabaseQuery` - The current query object or a new object extending the JDatabaseQuery class. Throws `RuntimeException` Since 12.1
`public static`	# `setInstance( JDatabaseFactory $instance = null )` Gets an instance of a factory object to return on subsequent calls of getInstance. Gets an instance of a factory object to return on subsequent calls of getInstance. Parameters `$instance` `JDatabaseFactory` - $instance A JDatabaseFactory object. Since 12.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JDatabaseFactory

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Since

Magic methods summary