CacheRegistry (class)
Class CacheRegistry
An object registry for cache engines.
Used by Cake\Cache\Cache to load and manage cache engines.
- Cake\Core\ObjectRegistry
-
Cake\Cache\CacheRegistry
Inherited Properties
Method Summary
- _create() protectedCreate the cache engine instance.
- _resolveClassName() protectedResolve a cache engine classname.
- _throwMissingClassError() protectedThrows an exception when a cache engine is missing.
- unload() publicRemove a single adapter from the registry.
Method Detail
_create()source protected
_create( string|Cake\Cache\CacheEngine $class , string $alias , array $config )
Create the cache engine instance.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
- string|
Cake\Cache\CacheEngine
$class
- The classname or object to make.
- string
$alias
- The alias of the object.
- array
$config
- An array of settings to use for the cache engine.
Returns
Cake\Cache\CacheEngine
The constructed CacheEngine class.
Throws
RuntimeExceptionwhen an object doesn't implement the correct interface.
_resolveClassName()source protected
_resolveClassName( string $class )
Resolve a cache engine classname.
Part of the template method for Cake\Core\ObjectRegistry::load()
Parameters
- string
$class
- Partial classname to resolve.
Returns
string|falseEither the correct classname or false.
_throwMissingClassError()source protected
_throwMissingClassError( string $class , string $plugin )
Throws an exception when a cache engine 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 cache is missing in.
Throws
BadMethodCallExceptionunload()source public
unload( string $name )
Remove a single adapter from the registry.
Parameters
- string
$name
- The adapter name.
Overrides
Cake\Core\ObjectRegistry::unload()
Methods inherited from Cake\Core\ObjectRegistry
__get()source public
__get( string $name )
Provide public read access to the loaded objects
Parameters
- string
$name
- Name of property to read
Returns
mixed__isset()source public
__isset( string $name )
Provide isset access to _loaded
Parameters
- string
$name
- Name of object being checked.
Returns
boolean_checkDuplicate()source protected
_checkDuplicate( string $name , array $config )
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
RuntimeExceptionWhen a duplicate is found.
get()source public
get( string $name )
Get loaded object instance.
Parameters
- string
$name
- Name of object.
Returns
object|nullObject instance if loaded else null.
has()source public
has( string $name )
Check whether or not a given object is loaded.
Parameters
- string
$name
- The object name to check for.
Returns
booleanTrue is object is loaded else false.
load()source public
load( string $objectName , array $config [] )
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
optional [] - Additional settings to use when loading the object.
Returns
mixednormalizeArray()source public
normalizeArray( array $objects )
Normalizes an object array, creates an array that makes lazy loading easier
Parameters
- array
$objects
- Array of child objects to normalize.
Returns
arrayArray of normalized objects.
reset()source public
reset( )
Clear loaded instances in the registry.
If the registry subclass has an event manager, the objects will be detached from events as well.
set()source public
set( string $objectName , object $object )
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
© 2005–2017 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/3.4/class-Cake.Cache.CacheRegistry.html