vendor/sensio/framework-extra-bundle/src/Routing/AnnotatedRouteControllerLoader.php line 19

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Sensio\Bundle\FrameworkExtraBundle\Routing;
  14. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
  15. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route as FrameworkExtraBundleRoute;
  16. use Symfony\Component\Routing\Loader\AnnotationClassLoader;
  17. use Symfony\Component\Routing\Route;
  19. @trigger_error(sprintf('The "%s" class is deprecated since version 5.2. Use "%s" instead.', AnnotatedRouteControllerLoader::class, \Symfony\Bundle\FrameworkBundle\Routing\AnnotatedRouteControllerLoader::class), \E_USER_DEPRECATED);
  21. /**
  22. * AnnotatedRouteControllerLoader is an implementation of AnnotationClassLoader
  23. * that sets the '_controller' default based on the class and method names.
  24. *
  25. * It also parse the @Method annotation.
  26. *
  27. * @author Fabien Potencier <fabien@symfony.com>
  28. *
  29. * @deprecated since version 5.2
  30. */
  31. class AnnotatedRouteControllerLoader extends AnnotationClassLoader
  32. {
  33. /**
  34. * Configures the _controller default parameter and eventually the HTTP method
  35. * requirement of a given Route instance.
  36. *
  37. * @param mixed $annot The annotation class instance
  38. *
  39. * @throws \LogicException When the service option is specified on a method
  40. */
  41. protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, $annot)
  42. {
  43. // controller
  44. $classAnnot = $this->reader->getClassAnnotation($class, $this->routeAnnotationClass);
  45. if ($classAnnot instanceof FrameworkExtraBundleRoute && $service = $classAnnot->getService()) {
  46. $route->setDefault('_controller', $service.':'.$method->getName());
  47. } elseif ('__invoke' === $method->getName()) {
  48. $route->setDefault('_controller', $class->getName());
  49. } else {
  50. $route->setDefault('_controller', $class->getName().'::'.$method->getName());
  51. }
  53. // requirements (@Method)
  54. foreach ($this->reader->getMethodAnnotations($method) as $configuration) {
  55. if ($configuration instanceof Method) {
  56. $route->setMethods($configuration->getMethods());
  57. } elseif ($configuration instanceof FrameworkExtraBundleRoute && $configuration->getService()) {
  58. throw new \LogicException('The service option can only be specified at class level.');
  59. }
  60. }
  61. }
  63. protected function getGlobals(\ReflectionClass $class)
  64. {
  65. $globals = parent::getGlobals($class);
  67. foreach ($this->reader->getClassAnnotations($class) as $configuration) {
  68. if ($configuration instanceof Method) {
  69. $globals['methods'] = array_merge($globals['methods'], $configuration->getMethods());
  70. }
  71. }
  73. return $globals;
  74. }
  76. /**
  77. * Makes the default route name more sane by removing common keywords.
  78. *
  79. * @return string The default route name
  80. */
  81. protected function getDefaultRouteName(\ReflectionClass $class, \ReflectionMethod $method)
  82. {
  83. $routeName = parent::getDefaultRouteName($class, $method);
  85. return preg_replace(
  86. ['/(bundle|controller)_/', '/action(_\d+)?$/', '/__/'],
  87. ['_', '\\1', '_'],
  88. $routeName
  89. );
  90. }
  91. }