vendor/pimcore/pimcore/bundles/CoreBundle/Request/ParamConverter/DataObjectParamResolver.php line 85

Open in your IDE?
  1. <?php
  2. declare(strict_types=1);
  4. /**
  5.  * Pimcore
  6.  *
  7.  * This source file is available under two different licenses:
  8.  * - GNU General Public License version 3 (GPLv3)
  9.  * - Pimcore Commercial License (PCL)
  10.  * Full copyright and license information is available in
  11.  * LICENSE.md which is distributed with this source code.
  12.  *
  13.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  14.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  15.  */
  17. namespace Pimcore\Bundle\CoreBundle\Request\ParamConverter;
  19. use Pimcore\Model\DataObject\AbstractObject;
  20. use Pimcore\Model\DataObject\Concrete;
  21. use Pimcore\Request\Attribute\DataObjectParam;
  22. use Pimcore\Tool;
  23. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
  24. use Symfony\Component\HttpFoundation\Request;
  25. use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
  26. use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
  27. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  29. /**
  30.  * @internal
  31.  */
  32. class DataObjectParamResolver implements ArgumentValueResolverInterface
  33. {
  34.     /**
  35.      * @return DataObjectParam[]
  36.      */
  37.     private function getDataObjectOptions(Request $request, ArgumentMetadata $argument): array
  38.     {
  39.         $options = $argument->getAttributes(DataObjectParam::class, ArgumentMetadata::IS_INSTANCEOF);
  41.         if (!isset($options[0])) {
  42.             $converters = $request->attributes->get('_converters');
  43.             $converter = $converters[0] ?? false;
  44.             if ($converter instanceof ParamConverter) {
  45.                 trigger_deprecation(
  46.                     'pimcore/pimcore',
  47.                     '10.6',
  48.                     'Usage of @ParamConverter annotation is deprecated. please use #[DataObjectParam] argument attribute instead.'
  49.                 );
  50.                 $options[0] = new DataObjectParam($converter->getClass(), $converter->getOptions()['unpublished'] ?? null, $converter->getOptions());
  51.             }
  52.         }
  54.         return $options;
  55.     }
  57.     /**
  58.      * {@inheritdoc}
  59.      *
  60.      * @throws NotFoundHttpException When invalid data object ID given
  61.      */
  62.     public function resolve(Request $request, ArgumentMetadata $argument): iterable
  63.     {
  64.         $options = $this->getDataObjectOptions($request, $argument);
  66.         $class = $options[0]->class ?? $argument->getType();
  67.         $param = $argument->getName();
  68.         $value = $request->attributes->get($param);
  70.         if (!$value && $argument->isNullable()) {
  71.             $request->attributes->set($param, null);
  73.             return [null];
  74.         }
  76.         /** @var Concrete|null $object */
  77.         $object = $value instanceof AbstractObject ? $value : $class::getById($value);
  78.         if (!$object) {
  79.             throw new NotFoundHttpException(sprintf('Invalid data object ID given for parameter "%s".', $param));
  80.         } elseif (
  81.             !$object->isPublished()
  82.             && !Tool::isElementRequestByAdmin($request, $object)
  83.             && (!isset($options[0]) || !$options[0]->unpublished)
  84.         ) {
  85.             throw new NotFoundHttpException(sprintf('Data object for parameter "%s" is not published.', $param));
  86.         }
  88.         $request->attributes->set($param, $object);
  90.         return [$object];
  91.     }
  93.     public function supports(Request $request, ArgumentMetadata $argument)
  94.     {
  95.         $param = $argument->getName();
  96.         if (!$request->attributes->has($param)) {
  97.             return false;
  98.         }
  100.         $options = $this->getDataObjectOptions($request, $argument);
  101.         $class = $options[0]->class ?? $argument->getType();
  103.         return $class !== null && is_subclass_of($class, AbstractObject::class);
  104.     }
  105. }