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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<?php
/**
* @see https://github.com/laminas/laminas-cache for the canonical source repository
* @copyright https://github.com/laminas/laminas-cache/blob/master/COPYRIGHT.md
* @license https://github.com/laminas/laminas-cache/blob/master/LICENSE.md New BSD License
*/
namespace Laminas\Cache\Storage;
use Laminas\Cache\Exception;
use Laminas\ServiceManager\AbstractPluginManager;
use Laminas\ServiceManager\Exception\InvalidServiceException;
use Laminas\ServiceManager\Factory\InvokableFactory;
/**
* Plugin manager implementation for cache plugins
*
* Enforces that plugins retrieved are instances of
* Plugin\PluginInterface. Additionally, it registers a number of default
* plugins available.
*/
class PluginManager extends AbstractPluginManager
{
protected $aliases = [
'clear_expired_by_factor' => Plugin\ClearExpiredByFactor::class,
'clearexpiredbyfactor' => Plugin\ClearExpiredByFactor::class,
'clearExpiredByFactor' => Plugin\ClearExpiredByFactor::class,
'ClearExpiredByFactor' => Plugin\ClearExpiredByFactor::class,
'exception_handler' => Plugin\ExceptionHandler::class,
'exceptionhandler' => Plugin\ExceptionHandler::class,
'exceptionHandler' => Plugin\ExceptionHandler::class,
'ExceptionHandler' => Plugin\ExceptionHandler::class,
'ignore_user_abort' => Plugin\IgnoreUserAbort::class,
'ignoreuserabort' => Plugin\IgnoreUserAbort::class,
'ignoreUserAbort' => Plugin\IgnoreUserAbort::class,
'IgnoreUserAbort' => Plugin\IgnoreUserAbort::class,
'optimize_by_factor' => Plugin\OptimizeByFactor::class,
'optimizebyfactor' => Plugin\OptimizeByFactor::class,
'optimizeByFactor' => Plugin\OptimizeByFactor::class,
'OptimizeByFactor' => Plugin\OptimizeByFactor::class,
'serializer' => Plugin\Serializer::class,
'Serializer' => Plugin\Serializer::class,
// Legacy Zend Framework aliases
\Zend\Cache\Storage\Plugin\ClearExpiredByFactor::class => Plugin\ClearExpiredByFactor::class,
\Zend\Cache\Storage\Plugin\ExceptionHandler::class => Plugin\ExceptionHandler::class,
\Zend\Cache\Storage\Plugin\IgnoreUserAbort::class => Plugin\IgnoreUserAbort::class,
\Zend\Cache\Storage\Plugin\OptimizeByFactor::class => Plugin\OptimizeByFactor::class,
\Zend\Cache\Storage\Plugin\Serializer::class => Plugin\Serializer::class,
// v2 normalized FQCNs
'zendcachestoragepluginclearexpiredbyfactor' => Plugin\ClearExpiredByFactor::class,
'zendcachestoragepluginexceptionhandler' => Plugin\ExceptionHandler::class,
'zendcachestoragepluginignoreuserabort' => Plugin\IgnoreUserAbort::class,
'zendcachestoragepluginoptimizebyfactor' => Plugin\OptimizeByFactor::class,
'zendcachestoragepluginserializer' => Plugin\Serializer::class,
];
protected $factories = [
Plugin\ClearExpiredByFactor::class => InvokableFactory::class,
Plugin\ExceptionHandler::class => InvokableFactory::class,
Plugin\IgnoreUserAbort::class => InvokableFactory::class,
Plugin\OptimizeByFactor::class => InvokableFactory::class,
Plugin\Serializer::class => InvokableFactory::class,
// v2 normalized FQCNs
'laminascachestoragepluginclearexpiredbyfactor' => InvokableFactory::class,
'laminascachestoragepluginexceptionhandler' => InvokableFactory::class,
'laminascachestoragepluginignoreuserabort' => InvokableFactory::class,
'laminascachestoragepluginoptimizebyfactor' => InvokableFactory::class,
'laminascachestoragepluginserializer' => InvokableFactory::class,
];
/**
* Do not share by default (v3)
*
* @var array
*/
protected $sharedByDefault = false;
/**
* Do not share by default (v2)
*
* @var array
*/
protected $shareByDefault = false;
/**
* @var string
*/
protected $instanceOf = Plugin\PluginInterface::class;
/**
* {@inheritdoc}
*/
public function validate($instance)
{
if ($instance instanceof $this->instanceOf) {
// we're okay
return;
}
throw new InvalidServiceException(sprintf(
'Plugin of type %s is invalid; must implement %s\Plugin\PluginInterface',
(is_object($instance) ? get_class($instance) : gettype($instance)),
__NAMESPACE__
));
}
/**
* Validate the plugin
*
* Checks that the plugin loaded is an instance of Plugin\PluginInterface.
*
* @param mixed $plugin
* @return void
* @throws Exception\RuntimeException if invalid
*/
public function validatePlugin($plugin)
{
try {
$this->validate($plugin);
} catch (InvalidServiceException $e) {
throw new Exception\RuntimeException($e->getMessage(), $e->getCode(), $e);
}
}
}