\Cake\CacheCacheRegistry

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

Throws

\Exception

If the class cannot be found.

Returns

loaded()

loaded() : array<mixed,string>

Get the list of loaded objects.

Returns

List of object names.

has()

has(string  $name) : boolean

Check whether or not a given object is loaded.

Parameters

Returns

True is object is loaded else false.

get()

get(string  $name) : object|null

Get loaded object instance.

Parameters

Returns

Object instance if loaded else null.

__get()

__get(string  $name) : mixed

Provide public read access to the loaded objects

Parameters

Returns

__isset()

__isset(string  $name) : boolean

Provide isset access to _loaded

Parameters

Returns

__set()

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

Sets an object.

Parameters

__unset()

__unset(string  $name) : void

Unsets an object.

Parameters

normalizeArray()

normalizeArray(array  $objects) : array

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

Parameters

Returns

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

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

Returns

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

getIterator()

getIterator() : \ArrayIterator

Returns an array iterator.

Returns

count()

count() : integer

Returns the number of loaded objects.

Returns

__debugInfo()

__debugInfo() : array

Debug friendly object properties.

Returns

_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

Throws

\RuntimeException

When a duplicate is found.

_resolveClassName()

_resolveClassName(string  $class) : string|false

Resolve a cache engine classname.

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

Parameters

Returns

Either the correct classname or false.

_throwMissingClassError()

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

Throws an exception when a cache engine is missing.

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

Parameters

Throws

\BadMethodCallException

_create()

_create(string|\Cake\Cache\CacheEngine  $class, string  $alias, array  $config) : \Cake\Cache\CacheEngine

Create the cache engine instance.

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

Parameters

Throws

\RuntimeException

when an object doesn't implement the correct interface.

Returns

The constructed CacheEngine class.