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

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.     /**
  26.      * @var ContaoFramework
  27.      */
  28.     private $framework;
  30.     /**
  31.      * @var ScopeMatcher
  32.      */
  33.     private $scopeMatcher;
  35.     /**
  36.      * @internal Do not inherit from this class; decorate the "contao.model_argument_resolver" service instead
  37.      */
  38.     public function __construct(ContaoFramework $framework, ScopeMatcher $scopeMatcher)
  39.     {
  40.         $this->framework = $framework;
  41.         $this->scopeMatcher = $scopeMatcher;
  42.     }
  44.     public function supports(Request $request, ArgumentMetadata $argument): bool
  45.     {
  46.         if (!$this->scopeMatcher->isContaoRequest($request)) {
  47.             return false;
  48.         }
  50.         $this->framework->initialize();
  52.         if (!is_a($argument->getType(), Model::class, true)) {
  53.             return false;
  54.         }
  56.         if (!$argument->isNullable() && null === $this->fetchModel($request, $argument)) {
  57.             return false;
  58.         }
  60.         return true;
  61.     }
  63.     public function resolve(Request $request, ArgumentMetadata $argument): \Generator
  64.     {
  65.         yield $this->fetchModel($request, $argument);
  66.     }
  68.     private function fetchModel(Request $request, ArgumentMetadata $argument): ?Model
  69.     {
  70.         $name = $this->getArgumentName($request, $argument);
  72.         if (null === $name) {
  73.             return null;
  74.         }
  76.         $value = $request->attributes->get($name);
  77.         $type = $argument->getType();
  79.         if ($type && $value instanceof $type) {
  80.             return $value;
  81.         }
  83.         // Special handling for pageModel that could be globally registered
  84.         if (
  85.             isset($GLOBALS['objPage'])
  86.             && $GLOBALS['objPage'] instanceof PageModel
  87.             && (int) $GLOBALS['objPage']->id === (int) $value
  88.             && is_a($type, PageModel::class, true)
  89.         ) {
  90.             return $GLOBALS['objPage'];
  91.         }
  93.         /** @var Model $model */
  94.         $model = $this->framework->getAdapter($argument->getType());
  96.         return $model->findByPk((int) $value);
  97.     }
  99.     /**
  100.      * Returns the argument name from the model class.
  101.      */
  102.     private function getArgumentName(Request $request, ArgumentMetadata $argument): ?string
  103.     {
  104.         if ($request->attributes->has($argument->getName())) {
  105.             return $argument->getName();
  106.         }
  108.         $className = lcfirst($this->stripNamespace($argument->getType()));
  110.         if ($request->attributes->has($className)) {
  111.             return $className;
  112.         }
  114.         return null;
  115.     }
  117.     /**
  118.      * Strips the namespace from a class name.
  119.      */
  120.     private function stripNamespace(string $fqcn): string
  121.     {
  122.         if (false !== ($pos = strrpos($fqcn, '\\'))) {
  123.             return substr($fqcn, $pos + 1);
  124.         }
  126.         return $fqcn;
  127.     }
  128. }