-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
CacheRegistry.php
108 lines (98 loc) · 3.5 KB
/
CacheRegistry.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Cache;
use BadMethodCallException;
use Cake\Core\App;
use Cake\Core\Exception\CakeException;
use Cake\Core\ObjectRegistry;
/**
* An object registry for cache engines.
*
* Used by {@link \Cake\Cache\Cache} to load and manage cache engines.
*
* @extends \Cake\Core\ObjectRegistry<\Cake\Cache\CacheEngine>
*/
class CacheRegistry extends ObjectRegistry
{
/**
* Resolve a cache engine classname.
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
*
* @param string $class Partial classname to resolve.
* @return class-string<\Cake\Cache\CacheEngine>|null Either the correct classname or null.
*/
protected function _resolveClassName(string $class): ?string
{
/** @var class-string<\Cake\Cache\CacheEngine>|null */
return App::className($class, 'Cache/Engine', 'Engine');
}
/**
* Throws an exception when a cache engine is missing.
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
*
* @param string $class The classname that is missing.
* @param string|null $plugin The plugin the cache is missing in.
* @return void
* @throws \BadMethodCallException
*/
protected function _throwMissingClassError(string $class, ?string $plugin): void
{
throw new BadMethodCallException(sprintf('Cache engine `%s` is not available.', $class));
}
/**
* Create the cache engine instance.
*
* Part of the template method for Cake\Core\ObjectRegistry::load()
*
* @param \Cake\Cache\CacheEngine|class-string<\Cake\Cache\CacheEngine> $class The classname or object to make.
* @param string $alias The alias of the object.
* @param array<string, mixed> $config An array of settings to use for the cache engine.
* @return \Cake\Cache\CacheEngine The constructed CacheEngine class.
* @throws \Cake\Core\Exception\CakeException When the cache engine cannot be initialized.
*/
protected function _create(object|string $class, string $alias, array $config): CacheEngine
{
if (is_object($class)) {
$instance = $class;
} else {
$instance = new $class($config);
}
unset($config['className']);
assert($instance instanceof CacheEngine, 'Cache engines must extend `' . CacheEngine::class . '`.');
if (!$instance->init($config)) {
throw new CakeException(
sprintf(
'Cache engine `%s` is not properly configured. Check error log for additional information.',
$instance::class
)
);
}
return $instance;
}
/**
* Remove a single adapter from the registry.
*
* @param string $name The adapter name.
* @return $this
*/
public function unload(string $name)
{
unset($this->_loaded[$name]);
return $this;
}
}