Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
75.00% |
3 / 4 |
CRAP | |
93.10% |
27 / 29 |
| ParamConverterManager | |
0.00% |
0 / 1 |
|
75.00% |
3 / 4 |
16.08 | |
93.10% |
27 / 29 |
| addConverter | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 2 |
|||
| getConverter | |
100.00% |
1 / 1 |
2 | |
100.00% |
3 / 3 |
|||
| setRouteParameterConverters | |
100.00% |
1 / 1 |
7 | |
100.00% |
12 / 12 |
|||
| convert | |
100.00% |
1 / 1 |
6 | |
100.00% |
12 / 12 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\Core\ParamConverter\ParamConverterManager. | |
| */ | |
| namespace Drupal\Core\ParamConverter; | |
| use Symfony\Cmf\Component\Routing\RouteObjectInterface; | |
| use Symfony\Component\Routing\RouteCollection; | |
| /** | |
| * Manages converter services for converting request parameters to full objects. | |
| * | |
| * A typical use case for this would be upcasting (converting) a node id to a | |
| * node entity. | |
| */ | |
| class ParamConverterManager implements ParamConverterManagerInterface { | |
| /** | |
| * Array of loaded converter services keyed by their ids. | |
| * | |
| * @var array | |
| */ | |
| protected $converters = array(); | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function addConverter(ParamConverterInterface $param_converter, $id) { | |
| $this->converters[$id] = $param_converter; | |
| return $this; | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function getConverter($converter) { | |
| if (isset($this->converters[$converter])) { | |
| return $this->converters[$converter]; | |
| } | |
| else { | |
| throw new \InvalidArgumentException(sprintf('No converter has been registered for %s', $converter)); | |
| } | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function setRouteParameterConverters(RouteCollection $routes) { | |
| foreach ($routes->all() as $route) { | |
| if (!$parameters = $route->getOption('parameters')) { | |
| // Continue with the next route if no parameters have been defined. | |
| continue; | |
| } | |
| // Loop over all defined parameters and look up the right converter. | |
| foreach ($parameters as $name => &$definition) { | |
| if (isset($definition['converter'])) { | |
| // Skip parameters that already have a manually set converter. | |
| continue; | |
| } | |
| foreach (array_keys($this->converters) as $converter) { | |
| if ($this->getConverter($converter)->applies($definition, $name, $route)) { | |
| $definition['converter'] = $converter; | |
| break; | |
| } | |
| } | |
| } | |
| // Override the parameters array. | |
| $route->setOption('parameters', $parameters); | |
| } | |
| } | |
| /** | |
| * {@inheritdoc} | |
| */ | |
| public function convert(array $defaults) { | |
| /** @var $route \Symfony\Component\Routing\Route */ | |
| $route = $defaults[RouteObjectInterface::ROUTE_OBJECT]; | |
| // Skip this enhancer if there are no parameter definitions. | |
| if (!$parameters = $route->getOption('parameters')) { | |
| return $defaults; | |
| } | |
| // Invoke the registered converter for each parameter. | |
| foreach ($parameters as $name => $definition) { | |
| if (!isset($defaults[$name])) { | |
| // Do not try to convert anything that is already set to NULL. | |
| continue; | |
| } | |
| if (!isset($definition['converter'])) { | |
| // Continue if no converter has been specified. | |
| continue; | |
| } | |
| // If a converter returns NULL it means that the parameter could not be | |
| // converted. | |
| $defaults[$name] = $this->getConverter($definition['converter'])->convert($defaults[$name], $definition, $name, $defaults); | |
| if (!isset($defaults[$name])) { | |
| throw new ParamNotConvertedException(sprintf('The "%s" parameter was not converted for the path "%s" (route name: "%s")', $name, $route->getPath(), $defaults[RouteObjectInterface::ROUTE_NAME])); | |
| } | |
| } | |
| return $defaults; | |
| } | |
| } |