Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

270 lines (240 sloc) 7.283 kB
<?php
/**
* Datasource connection manager
*
* Provides an interface for loading and enumerating connections defined in app/Config/database.php
*
* PHP 5
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package cake.libs.model
* @since CakePHP(tm) v 0.10.x.1402
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
App::uses('DataSource', 'Model/Datasource');
/**
* Manages loaded instances of DataSource objects
*
* @package cake.libs.model
*/
class ConnectionManager {
/**
* Holds a loaded instance of the Connections object
*
* @var DATABASE_CONFIG
* @access public
*/
public static $config = null;
/**
* Holds instances DataSource objects
*
* @var array
* @access protected
*/
protected static $_dataSources = array();
/**
* Contains a list of all file and class names used in Connection settings
*
* @var array
* @access protected
*/
protected static $_connectionsEnum = array();
/**
* Indicates if the init code for this class has already been executed
*
* @var boolean
*/
private static $_init = false;
/**
* Loads connections configuration.
*
*/
private static function init() {
include_once APP . 'Config' . DS . 'database.php';
if (class_exists('DATABASE_CONFIG')) {
self::$config = new DATABASE_CONFIG();
}
register_shutdown_function('ConnectionManager::shutdown');
self::$_init = true;
}
/**
* Gets a reference to a DataSource object
*
* @param string $name The name of the DataSource, as defined in app/Config/database.php
* @return object Instance
* @throws MissingDatasourceConfigException
* @throws MissingDatasourceFileException
*/
public static function getDataSource($name) {
if (empty(self::$_init)) {
self::init();
}
if (!empty(self::$_dataSources[$name])) {
$return = self::$_dataSources[$name];
return $return;
}
if (empty(self::$_connectionsEnum[$name])) {
self::_getConnectionObject($name);
}
self::loadDataSource($name);
$conn = self::$_connectionsEnum[$name];
$class = $conn['classname'];
self::$_dataSources[$name] = new $class(self::$config->{$name});
self::$_dataSources[$name]->configKeyName = $name;
return self::$_dataSources[$name];
}
/**
* Gets the list of available DataSource connections
* This will only return the datasources instantiated by this manager
* It differs from enumConnectionObjects, since the latter will return all configured connections
*
* @return array List of available connections
*/
public static function sourceList() {
if (empty(self::$_init)) {
self::init();
}
return array_keys(self::$_dataSources);
}
/**
* Gets a DataSource name from an object reference.
*
* @param object $source DataSource object
* @return string Datasource name, or null if source is not present
* in the ConnectionManager.
*/
public static function getSourceName($source) {
if (empty(self::$_init)) {
self::init();
}
foreach (self::$_dataSources as $name => $ds) {
if ($ds === $source) {
return $name;
}
}
return null;
}
/**
* Loads the DataSource class for the given connection name
*
* @param mixed $connName A string name of the connection, as defined in app/Config/database.php,
* or an array containing the filename (without extension) and class name of the object,
* to be found in app/Model/Datasource/ or lib/Cake/Model/Datasource/.
* @return boolean True on success, null on failure or false if the class is already loaded
* @throws MissingDatasourceFileException
*/
public static function loadDataSource($connName) {
if (empty(self::$_init)) {
self::init();
}
if (is_array($connName)) {
$conn = $connName;
} else {
$conn = self::$_connectionsEnum[$connName];
}
if (class_exists($conn['classname'], false)) {
return false;
}
$plugin = $package = null;
if (!empty($conn['plugin'])) {
$plugin = $conn['plugin'] . '.';
}
if (!empty($conn['package'])) {
$package = '/' . $conn['package'];
}
App::uses($conn['classname'], $plugin . 'Model/Datasource' . $package);
if (!class_exists($conn['classname'])) {
throw new MissingDatasourceFileException(array('class' => $conn['classname'], 'plugin' => $plugin));
}
return true;
}
/**
* Return a list of connections
*
* @return array An associative array of elements where the key is the connection name
* (as defined in Connections), and the value is an array with keys 'filename' and 'classname'.
*/
public static function enumConnectionObjects() {
if (empty(self::$_init)) {
self::init();
}
return (array) self::$config;
}
/**
* Dynamically creates a DataSource object at runtime, with the given name and settings
*
* @param string $name The DataSource name
* @param array $config The DataSource configuration settings
* @return object A reference to the DataSource object, or null if creation failed
*/
public static function create($name = '', $config = array()) {
if (empty(self::$_init)) {
self::init();
}
if (empty($name) || empty($config) || array_key_exists($name, self::$_connectionsEnum)) {
return null;
}
self::$config->{$name} = $config;
self::$_connectionsEnum[$name] = self::_connectionData($config);
$return = self::getDataSource($name);
return $return;
}
/**
* Removes a connection configuration at runtime given its name
*
* @param string $name the connection name as it was created
* @return boolean success if connection was removed, false if it does not exist
*/
public static function drop($name) {
if (empty(self::$_init)) {
self::init();
}
if (!isset(self::$config->{$name})) {
return false;
}
unset(self::$_connectionsEnum[$name], self::$_dataSources[$name], self::$config->{$name});
return true;
}
/**
* Gets a list of class and file names associated with the user-defined DataSource connections
*
* @return void
*/
protected static function _getConnectionObject($name) {
if (!empty(self::$config->{$name})) {
self::$_connectionsEnum[$name] = self::_connectionData(self::$config->{$name});
} else {
throw new MissingDatasourceConfigException(array('config' => $name));
}
}
/**
* Returns the file, class name, and parent for the given driver.
*
* @return array An indexed array with: filename, classname, plugin and parent
*/
private static function _connectionData($config) {
$package = $classname = $plugin = null;
list($plugin, $classname) = pluginSplit($config['datasource']);
if (strpos($classname, '/') !== false) {
$package = dirname($classname);
$classname = basename($classname);
}
return compact('package', 'classname', 'plugin');
}
/**
* Destructor.
*
*/
public static function shutdown() {
if (Configure::read('Session.defaults') == 'database' && function_exists('session_write_close')) {
session_write_close();
}
}
}
Jump to Line
Something went wrong with that request. Please try again.