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
|
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Mvc\Router;
use Zend\ServiceManager\AbstractPluginManager;
/**
* Plugin manager implementation for routes
*
* Enforces that routes retrieved are instances of RouteInterface. It overrides
* createFromInvokable() to call the route's factory method in order to get an
* instance. The manager is marked to not share by default, in order to allow
* multiple route instances of the same type.
*/
class RoutePluginManager extends AbstractPluginManager
{
/**
* Do not share instances.
*
* @var bool
*/
protected $shareByDefault = false;
/**
* Override setInvokableClass().
*
* Performs normal operation, but also auto-aliases the class name to the
* service name. This ensures that providing the FQCN does not trigger an
* abstract factory later.
*
* @param string $name
* @param string $invokableClass
* @param null|bool $shared
* @return RoutePluginManager
*/
public function setInvokableClass($name, $invokableClass, $shared = null)
{
parent::setInvokableClass($name, $invokableClass, $shared);
if ($name != $invokableClass) {
$this->setAlias($invokableClass, $name);
}
return $this;
}
/**
* Validate the plugin.
*
* Checks that the filter loaded is either a valid callback or an instance
* of FilterInterface.
*
* @param mixed $plugin
* @return void
* @throws Exception\RuntimeException if invalid
*/
public function validatePlugin($plugin)
{
if ($plugin instanceof RouteInterface) {
// we're okay
return;
}
throw new Exception\RuntimeException(sprintf(
'Plugin of type %s is invalid; must implement %s\RouteInterface',
(is_object($plugin) ? get_class($plugin) : gettype($plugin)),
__NAMESPACE__
));
}
/**
* Attempt to create an instance via an invokable class.
*
* Overrides parent implementation by invoking the route factory,
* passing $creationOptions as the argument.
*
* @param string $canonicalName
* @param string $requestedName
* @return null|\stdClass
* @throws Exception\RuntimeException If resolved class does not exist, or does not implement RouteInterface
*/
protected function createFromInvokable($canonicalName, $requestedName)
{
$invokable = $this->invokableClasses[$canonicalName];
if (!class_exists($invokable)) {
throw new Exception\RuntimeException(sprintf(
'%s: failed retrieving "%s%s" via invokable class "%s"; class does not exist',
__METHOD__,
$canonicalName,
($requestedName ? '(alias: ' . $requestedName . ')' : ''),
$invokable
));
}
if (!static::isSubclassOf($invokable, __NAMESPACE__ . '\RouteInterface')) {
throw new Exception\RuntimeException(sprintf(
'%s: failed retrieving "%s%s" via invokable class "%s"; class does not implement %s\RouteInterface',
__METHOD__,
$canonicalName,
($requestedName ? '(alias: ' . $requestedName . ')' : ''),
$invokable,
__NAMESPACE__
));
}
return $invokable::factory($this->creationOptions);
}
}
|
