vendor/contao/core-bundle/src/HttpKernel/ModelArgumentResolver.php line 43

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6. * This file is part of Contao.
  7. *
  8. * (c) Leo Feyer
  9. *
  10. * @license LGPL-3.0-or-later
  11. */
  13. namespace Contao\CoreBundle\HttpKernel;
  15. use Contao\CoreBundle\Framework\ContaoFramework;
  16. use Contao\CoreBundle\Routing\ScopeMatcher;
  17. use Contao\Model;
  18. use Contao\PageModel;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
  21. use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
  23. class ModelArgumentResolver implements ArgumentValueResolverInterface
  24. {
  25. private ContaoFramework $framework;
  26. private ScopeMatcher $scopeMatcher;
  28. /**
  29. * @internal
  30. */
  31. public function __construct(ContaoFramework $framework, ScopeMatcher $scopeMatcher)
  32. {
  33. $this->framework = $framework;
  34. $this->scopeMatcher = $scopeMatcher;
  35. }
  37. public function supports(Request $request, ArgumentMetadata $argument): bool
  38. {
  39. if (!$this->scopeMatcher->isContaoRequest($request)) {
  40. return false;
  41. }
  43. $this->framework->initialize();
  45. if (!is_a($argument->getType(), Model::class, true)) {
  46. return false;
  47. }
  49. if (!$argument->isNullable() && null === $this->fetchModel($request, $argument)) {
  50. return false;
  51. }
  53. return true;
  54. }
  56. public function resolve(Request $request, ArgumentMetadata $argument): \Generator
  57. {
  58. yield $this->fetchModel($request, $argument);
  59. }
  61. private function fetchModel(Request $request, ArgumentMetadata $argument): ?Model
  62. {
  63. $name = $this->getArgumentName($request, $argument);
  65. if (null === $name) {
  66. return null;
  67. }
  69. /** @var class-string<Model> $type */
  70. $type = $argument->getType();
  71. $value = $request->attributes->get($name);
  73. if ($type && $value instanceof $type) {
  74. return $value;
  75. }
  77. // Special handling for pageModel that could be globally registered
  78. if (
  79. isset($GLOBALS['objPage'])
  80. && $GLOBALS['objPage'] instanceof PageModel
  81. && (int) $GLOBALS['objPage']->id === (int) $value
  82. && is_a($type, PageModel::class, true)
  83. ) {
  84. return $GLOBALS['objPage'];
  85. }
  87. /** @var Model $model */
  88. $model = $this->framework->getAdapter($type);
  90. return $model->findByPk((int) $value);
  91. }
  93. /**
  94. * Returns the argument name from the model class.
  95. */
  96. private function getArgumentName(Request $request, ArgumentMetadata $argument): ?string
  97. {
  98. if ($request->attributes->has($argument->getName())) {
  99. return $argument->getName();
  100. }
  102. $className = lcfirst($this->stripNamespace($argument->getType()));
  104. if ($request->attributes->has($className)) {
  105. return $className;
  106. }
  108. return null;
  109. }
  111. /**
  112. * Strips the namespace from a class name.
  113. */
  114. private function stripNamespace(string $fqcn): string
  115. {
  116. if (false !== ($pos = strrpos($fqcn, '\\'))) {
  117. return substr($fqcn, $pos + 1);
  118. }
  120. return $fqcn;
  121. }
  122. }