ConnectionManager Class Info:
- Class Declaration:
class ConnectionManager extends Object
- File name:
- cake/libs/model/connection_manager.php
- Description:
Manages loaded instances of DataSource objects
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs.model
Properties:
-
config DATABASE_CONFIG
Holds a loaded instance of the Connections object
-
_connectionsEnum array
Contains a list of all file and class names used in Connection settings
-
_dataSources array
Holds instances DataSource objects
Method Summary:
- cakeError( $method, $messages = array ( ) )
- __connectionData( $config )
- __construct( )
- create( $name = '', $config = array ( ) )
- __destruct( )
- dispatchMethod( $method, $params = array ( ) )
- enumConnectionObjects( )
- _getConnectionObjects( )
- getDataSource( $name )
- getInstance( )
- getSourceName( $source )
- loadDataSource( $connName )
- log( $msg, $type = 2 )
- Object( )
- __openPersistent( $name, $type = NULL )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- sourceList( )
- _stop( $status = 0 )
- toString( )
cakeError
topUsed 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 required
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
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
__connectionData
topReturns the file, class name, and parent for the given driver.
- Parameters:
-
-
$config required
-
- Method defined in:
- cake/libs/model/connection_manager.php on line 252
- Return
array An indexed array with: filename, classname, plugin and parent
- Access
private
create
topDynamically 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
-
- Method defined in:
- cake/libs/model/connection_manager.php on line 214
- Return
object A reference to the DataSource object, or null if creation failed
- Access
public
- Static
__destruct
topdispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
enumConnectionObjects
topReturn a list of connections
- Method defined in:
- cake/libs/model/connection_manager.php on line 199
- 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'.
- Access
public
- Static
_getConnectionObjects
topGets a list of class and file names associated with the user-defined DataSource connections
- Method defined in:
- cake/libs/model/connection_manager.php on line 234
- Return
void
- Access
protected
- Static
getDataSource
topGets a reference to a DataSource object
- Parameters:
-
-
string $name required
The name of the DataSource, as defined in app/config/database.php
-
- Method defined in:
- cake/libs/model/connection_manager.php on line 93
- Return
object Instance
- Access
public
- Static
getInstance
topGets a reference to the ConnectionManger object instance
- Method defined in:
- cake/libs/model/connection_manager.php on line 75
- Return
object Instance
- Access
public
- Static
getSourceName
topGets a DataSource name from an object reference.
Warning this method may cause fatal errors in PHP4.
- Parameters:
-
-
object $source required
DataSource object
-
- Method defined in:
- cake/libs/model/connection_manager.php on line 144
- Return
string Datasource name, or null if source is not present in the ConnectionManager.
- Access
public
- Static
loadDataSource
topLoads the DataSource class for the given connection name
- Parameters:
-
-
mixed $connName required
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/.
-
- Method defined in:
- cake/libs/model/connection_manager.php on line 164
- Return
boolean True on success, null on failure or false if the class is already loaded
- Access
public
- Static
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA 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()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
__openPersistent
topOpen the persistent class file for reading Used by Object::_persist()
- Parameters:
-
-
string $name required
Name of persisted class
-
string $type optional NULL
Type of persistance (e.g: registry)
-
- Method defined in:
- cake/libs/object.php on line 268
- Return
void
- Access
private
_persist
topChecks 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 required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
requestAction
topCalls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
- Parameters:
-
-
mixed $url required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
- Parameters:
-
-
array $properties optional array ( )
An associative array containing properties and corresponding values.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
sourceList
topGets the list of available DataSource connections
- Method defined in:
- cake/libs/model/connection_manager.php on line 128
- Return
array List of available connections
- Access
public
- Static
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
