3 namespace Drupal\Core\ParamConverter;
5 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
6 use Symfony\Component\Routing\RouteCollection;
9 * Manages converter services for converting request parameters to full objects.
11 * A typical use case for this would be upcasting (converting) a node id to a
14 class ParamConverterManager implements ParamConverterManagerInterface {
17 * Array of loaded converter services keyed by their ids.
21 protected $converters = [];
26 public function addConverter(ParamConverterInterface $param_converter, $id) {
27 $this->converters[$id] = $param_converter;
34 public function getConverter($converter) {
35 if (isset($this->converters[$converter])) {
36 return $this->converters[$converter];
39 throw new \InvalidArgumentException(sprintf('No converter has been registered for %s', $converter));
46 public function setRouteParameterConverters(RouteCollection $routes) {
47 foreach ($routes->all() as $route) {
48 if (!$parameters = $route->getOption('parameters')) {
49 // Continue with the next route if no parameters have been defined.
53 // Loop over all defined parameters and look up the right converter.
54 foreach ($parameters as $name => &$definition) {
55 if (isset($definition['converter'])) {
56 // Skip parameters that already have a manually set converter.
60 foreach (array_keys($this->converters) as $converter) {
61 if ($this->getConverter($converter)->applies($definition, $name, $route)) {
62 $definition['converter'] = $converter;
68 // Override the parameters array.
69 $route->setOption('parameters', $parameters);
76 public function convert(array $defaults) {
77 /** @var $route \Symfony\Component\Routing\Route */
78 $route = $defaults[RouteObjectInterface::ROUTE_OBJECT];
80 // Skip this enhancer if there are no parameter definitions.
81 if (!$parameters = $route->getOption('parameters')) {
85 // Invoke the registered converter for each parameter.
86 foreach ($parameters as $name => $definition) {
87 if (!isset($defaults[$name])) {
88 // Do not try to convert anything that is already set to NULL.
92 if (!isset($definition['converter'])) {
93 // Continue if no converter has been specified.
97 // If a converter returns NULL it means that the parameter could not be
99 $defaults[$name] = $this->getConverter($definition['converter'])->convert($defaults[$name], $definition, $name, $defaults);
100 if (!isset($defaults[$name])) {
101 throw new ParamNotConvertedException(sprintf('The "%s" parameter was not converted for the path "%s" (route name: "%s")', $name, $route->getPath(), $defaults[RouteObjectInterface::ROUTE_NAME]));