Class ConnectionManager
Manages loaded instances of DataSource objects
Long description for file
- Object
-
ConnectionManager
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: model/connection_manager.php
Properties summary
-
$_connectionsEnumpublicarrayContains a list of all file and class names used in Connection settings -
$_dataSourcespublicarrayHolds instances DataSource objects -
$configpublicDATABASE_CONFIGHolds a loaded instance of the Connections object
Inherited Properties
Method Summary
-
__construct() public
Constructor. -
__destruct() public
Destructor. -
__getDriver() public
Returns the file, class name, and parent for the given driver. -
create() public
Dynamically creates a DataSource object at runtime, with the given name and settings -
enumConnectionObjects() public
Gets a list of class and file names associated with the user-defined DataSource connections -
getDataSource() public
Gets a reference to a DataSource object -
getInstance() public
Gets a reference to the ConnectionManger object instance -
getSourceName() public
Gets a DataSource name from an object reference -
loadDataSource() public
Loads the DataSource class for the given connection name -
sourceList() public
Gets the list of available DataSource connections
Method Detail
__getDriver() public ¶
__getDriver( $config )
Returns the file, class name, and parent for the given driver.
Returns
An indexed array with: filename, classname, and parent
create() public ¶
create( string $name = '' , array $config = array() )
Dynamically creates a DataSource object at runtime, with the given name and settings
Parameters
- string $name optional ''
- The DataSource name
- array $config optional array()
- The DataSource configuration settings
Returns
A reference to the DataSource object, or null if creation failed
enumConnectionObjects() public ¶
enumConnectionObjects( )
Gets a list of class and file names associated with the user-defined DataSource connections
Returns
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'.
getDataSource() public ¶
getDataSource( string $name )
Gets a reference to a DataSource object
Parameters
- string $name
- The name of the DataSource, as defined in app/config/database.php
Returns
Instance
getInstance() public ¶
getInstance( )
Gets a reference to the ConnectionManger object instance
Returns
Instance
getSourceName() public ¶
getSourceName( object $source )
Gets a DataSource name from an object reference
Parameters
- object $source
- DataSource object
Returns
Datasource name
loadDataSource() public ¶
loadDataSource( mixed $connName )
Loads the DataSource class for the given connection name
Parameters
- 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/models/datasources/ or cake/libs/model/datasources/.
Returns
True on success, null on failure or false if the class is already loaded
sourceList() public ¶
sourceList( )
Gets the list of available DataSource connections
Returns
List of available connections
Methods inherited from Object
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
dispatchMethod() public ¶
dispatchMethod( string $method , array $params = array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
API for logging events.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class
Properties detail
$_connectionsEnum ¶
Contains a list of all file and class names used in Connection settings
array()