A registry object for connection instances.
array<object>Map of loaded objects.
Debug friendly object properties.
Provide public read access to the loaded objects
Provide isset access to _loaded
Sets an object.
Unsets an object.
Check for duplicate object loading.
Create the connection object with the correct settings.
Resolve a datasource classname.
Throws an exception when a datasource is missing
Returns the number of loaded objects.
Get loaded object instance.
Returns an array iterator.
Check whether a given object is loaded.
Loads/constructs an object instance.
Get the list of loaded objects.
Normalizes an object array, creates an array that makes lazy loading easier
Clear loaded instances in the registry.
Set an object directly into the registry by name.
Remove a single adapter from the registry.
__debugInfo(): array<string, mixed>
Debug friendly object properties.
array<string, mixed>__get(string $name): object|null
Provide public read access to the loaded objects
string $name Name of property to read
object|null__isset(string $name): bool
Provide isset access to _loaded
string $name Name of object being checked.
bool__set(string $name, object $object): void
Sets an object.
string $name Name of a property to set.
object $object Object to set.
void__unset(string $name): void
Unsets an object.
string $name Name of a property to unset.
void_checkDuplicate(string $name, array<string, mixed> $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.
string $name The name of the alias in the registry.
array<string, mixed> $config The config data for the new instance.
voidRuntimeException_create(object|string $class, string $alias, array<string, mixed> $config): Cake\Datasource\ConnectionInterface
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.
object|string $class The classname or object to make.
string $alias The alias of the object.
array<string, mixed> $config An array of settings to use for the datasource.
Cake\Datasource\ConnectionInterface_resolveClassName(string $class): string|null
Resolve a datasource classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
string $class Partial classname to resolve.
string|null_throwMissingClassError(string $class, string|null $plugin): void
Throws an exception when a datasource is missing
Part of the template method for Cake\Core\ObjectRegistry::load()
string $class The classname that is missing.
string|null $plugin The plugin the datasource is missing in.
voidCake\Datasource\Exception\MissingDatasourceExceptioncount(): int
Returns the number of loaded objects.
intget(string $name): object
Get loaded object instance.
string $name Name of object.
objectRuntimeExceptiongetIterator(): Traversable
Returns an array iterator.
Traversablehas(string $name): bool
Check whether a given object is loaded.
string $name The object name to check for.
boolload(string $name, array<string, mixed> $config = []): 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 {@link \Cake\Controller\Component::$components} as an example. You can alias an object by setting the 'className' key, i.e.,
protected $components = [
'Email' => [
'className' => 'App\Controller\Component\AliasedEmailComponent'
];
]; All calls to the Email component would use AliasedEmail instead.
string $name The name/class of the object to load.
array<string, mixed> $config optional Additional settings to use when loading the object.
mixedExceptionloaded(): array<string>
Get the list of loaded objects.
array<string>normalizeArray(array $objects): array<string, array>
Normalizes an object array, creates an array that makes lazy loading easier
array $objects Array of child objects to normalize.
array<string, array>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.
$thisset(string $name, 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
string $name The name of the object to set in the registry.
object $object instance to store in the registry
$thisunload(string $name): $this
Remove a single adapter from the registry.
If this registry has an event manager, the object will be detached from any events as well.
string $name The adapter name.
$thisMap of loaded objects.
array<object>
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Datasource.ConnectionRegistry.html