Class FOFDatabaseFactory

Joomla Platform Database Factory class

Package: FrameworkOnFramework\database
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt This file is adapted from the Joomla! Platform. It is used to iterate a database cursor returning FOFTable objects instead of plain stdClass objects
Since: 12.1
Located at fof/database/factory.php

Methods summary

`public FOFDatabaseDriver`	# `getDriver( string $name = 'joomla', array $options = array() )` Method to return a FOFDatabaseDriver 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 FOFDatabaseDriver 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 `FOFDatabaseDriver` - A database driver object. Throws `RuntimeException` Since 12.1
`public static FOFDatabaseFactory`	# `getInstance( )` Gets an instance of the factory object. Gets an instance of the factory object. Returns `FOFDatabaseFactory` Since 12.1
`public FOFDatabaseQuery`	# `getQuery( string $name, FOFDatabaseDriver $db = null )` Get the current query object or a new FOFDatabaseQuery object. Get the current query object or a new FOFDatabaseQuery object. Parameters `$name` `string` - $name Name of the driver you want an query object for. `$db` `FOFDatabaseDriver` - $db Optional FOFDatabaseDriver instance Returns `FOFDatabaseQuery` - The current query object or a new object extending the FOFDatabaseQuery class. Throws `RuntimeException` Since 12.1
`public static`	# `setInstance( FOFDatabaseFactory $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` `FOFDatabaseFactory` - $instance A FOFDatabaseFactory object. Since 12.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDatabaseFactory

Methods summary

Parameters

Returns

Throws

Since

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Since

Magic methods summary