\Cake\DatasourceConnectionRegistry

A registry object for connection instances.

Provides registry & factory functionality for object types. Used as a super class for various composition based re-use features in CakePHP.

Each subclass needs to implement the various abstract methods to complete the template method load().

The ObjectRegistry is EventManager aware, but each extending class will need to use \Cake\Event\EventDispatcherTrait to attach and detach on set and bind

Summary

Methods

Properties

Constants

load()
loaded()
has()
get()
__get()
__isset()
__set()
__unset()
normalizeArray()
reset()
set()
unload()
getIterator()
count()
__debugInfo()

No public properties found

No constants found

_checkDuplicate()
_resolveClassName()
_throwMissingClassError()
_create()

$_loaded

N/A

No private methods found

No private properties found

N/A

Properties

$_loaded

$_loaded : array<mixed,object>

Map of loaded objects.

Type

array<mixed,object>

Methods

load()

load(string  $objectName, array  $config = array()) : mixed

Loads/constructs an object instance.

Will return the instance in the registry if it already exists. If a subclass provides event support, you can use $config['enabled'] = false to exclude constructed objects from being registered for events.

Using Cake\Controller\Controller::$components as an example. You can alias an object by setting the 'className' key, i.e.,

public $components = [
  'Email' => [
    'className' => '\App\Controller\Component\AliasedEmailComponent'
  ];
];

All calls to the Email component would use AliasedEmail instead.

Parameters

string	$objectName	The name/class of the object to load.
array	$config	Additional settings to use when loading the object.

Throws

\Exception: If the class cannot be found.

Returns

mixed

loaded()

loaded() : array<mixed,string>

Get the list of loaded objects.

Returns

array<mixed,string> —

List of object names.

has()

has(string  $name) : boolean

Check whether or not a given object is loaded.

Parameters

string

$name

The object name to check for.

Returns

boolean —

True is object is loaded else false.

get()

get(string  $name) : object|null

Get loaded object instance.

Parameters

string

$name

Name of object.

Returns

object|null —

Object instance if loaded else null.

__get()

__get(string  $name) : mixed

Provide public read access to the loaded objects

Parameters

string

$name

Name of property to read

Returns

mixed

__isset()

__isset(string  $name) : boolean

Provide isset access to _loaded

Parameters

string

$name

Name of object being checked.

Returns

boolean

__set()

__set(string  $name, mixed  $object) : void

Sets an object.

Parameters

string	$name	Name of a property to set.
mixed	$object	Object to set.

__unset()

__unset(string  $name) : void

Unsets an object.

Parameters

string

$name

Name of a property to unset.

normalizeArray()

normalizeArray(array  $objects) : array

Normalizes an object array, creates an array that makes lazy loading easier

Parameters

array

$objects

Array of child objects to normalize.

Returns

array —

Array of normalized objects.

reset()

reset() : $this

Clear loaded instances in the registry.

If the registry subclass has an event manager, the objects will be detached from events as well.

Returns

$this

set()

set(string  $objectName, object  $object) : $this

Set an object directly into the registry by name.

If this collection implements events, the passed object will be attached into the event manager

Parameters

string	$objectName	The name of the object to set in the registry.
object	$object	instance to store in the registry

Returns

$this

unload()

unload(string  $name) : void

Remove a single adapter from the registry.

If this registry has an event manager, the object will be detached from any events as well.

Parameters

string

$name

The adapter name.

getIterator()

getIterator() : \ArrayIterator

Returns an array iterator.

Returns

\ArrayIterator

count()

count() : integer

Returns the number of loaded objects.

Returns

integer

__debugInfo()

__debugInfo() : array

Debug friendly object properties.

Returns

array

_checkDuplicate()

_checkDuplicate(string  $name, array  $config) : void

Check for duplicate object loading.

If a duplicate is being loaded and has different configuration, that is bad and an exception will be raised.

An exception is raised, as replacing the object will not update any references other objects may have. Additionally, simply updating the runtime configuration is not a good option as we may be missing important constructor logic dependent on the configuration.

Parameters

string	$name	The name of the alias in the registry.
array	$config	The config data for the new instance.

Throws

\RuntimeException: When a duplicate is found.

_resolveClassName()

_resolveClassName(string  $class) : string|false

Resolve a datasource classname.

Part of the template method for Cake\Core\ObjectRegistry::load()

Parameters

string

$class

Partial classname to resolve.

Returns

string|false —

Either the correct classname or false.

_throwMissingClassError()

_throwMissingClassError(string  $class, string  $plugin) : void

Throws an exception when a datasource is missing

Part of the template method for Cake\Core\ObjectRegistry::load()

Parameters

string	$class	The classname that is missing.
string	$plugin	The plugin the datasource is missing in.

Throws

\Cake\Datasource\Exception\MissingDatasourceException

_create()

_create(string|object|callable  $class, string  $alias, array  $settings) : object

Create the connection object with the correct settings.

Part of the template method for Cake\Core\ObjectRegistry::load()

If a callable is passed as first argument, The returned value of this function will be the result of the callable.

Parameters

string\|object\|callable	$class	The classname or object to make.
string	$alias	The alias of the object.
array	$settings	An array of settings to use for the datasource.

Returns

object —

A connection with the correct settings.