vendor/sonata-project/media-bundle/src/Admin/BaseMediaAdmin.php line 53

  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\MediaBundle\Admin;
  16. use Sonata\AdminBundle\Admin\AbstractAdmin;
  17. use Sonata\AdminBundle\Datagrid\ListMapper;
  18. use Sonata\AdminBundle\Form\FormMapper;
  19. use Sonata\AdminBundle\Form\Type\ModelListType;
  20. use Sonata\AdminBundle\Object\Metadata;
  21. use Sonata\AdminBundle\Object\MetadataInterface;
  22. use Sonata\ClassificationBundle\Model\CategoryManagerInterface;
  23. use Sonata\ClassificationBundle\Model\ContextManagerInterface;
  24. use Sonata\MediaBundle\Form\DataTransformer\ProviderDataTransformer;
  25. use Sonata\MediaBundle\Provider\MediaProviderInterface;
  26. use Sonata\MediaBundle\Provider\Pool;
  27. use Symfony\Component\Form\Extension\Core\Type\HiddenType;
  29. /**
  30.  * @phpstan-extends AbstractAdmin<\Sonata\MediaBundle\Model\MediaInterface>
  31.  */
  32. abstract class BaseMediaAdmin extends AbstractAdmin
  33. {
  34.     protected Pool $pool;
  36.     protected ?CategoryManagerInterface $categoryManager = null;
  38.     protected ?ContextManagerInterface $contextManager = null;
  40.     protected $classnameLabel = 'Media';
  42.     /**
  43.      * @phpstan-param class-string<\Sonata\MediaBundle\Model\MediaInterface> $class
  44.      */
  45.     public function __construct(
  46.         string $code,
  47.         string $class,
  48.         string $baseControllerName,
  49.         Pool $pool,
  50.         ?CategoryManagerInterface $categoryManager = null,
  51.         ?ContextManagerInterface $contextManager = null
  52.     ) {
  53.         parent::__construct($code, $class, $baseControllerName);
  55.         $this->pool = $pool;
  56.         $this->categoryManager = $categoryManager;
  57.         $this->contextManager = $contextManager;
  58.     }
  60.     final public function getObjectMetadata(object $object): MetadataInterface
  61.     {
  62.         $provider = $this->pool->getProvider($object->getProviderName());
  64.         $url = $provider->generatePublicUrl(
  65.             $object,
  66.             $provider->getFormatName($object, MediaProviderInterface::FORMAT_ADMIN)
  67.         );
  69.         return new Metadata($this->toString($object), $object->getDescription(), $url);
  70.     }
  72.     protected function prePersist(object $object): void
  73.     {
  74.         $parameters = $this->getPersistentParameters();
  75.         $object->setContext($parameters['context']);
  76.     }
  78.     protected function configurePersistentParameters(): array
  79.     {
  80.         $parameters = [];
  82.         if (!$this->hasRequest()) {
  83.             return $parameters;
  84.         }
  86.         $request = $this->getRequest();
  88.         // TODO: Change to $request->query->all('filter') when support for Symfony < 5.1 is dropped.
  89.         $filter = $request->query->all()['filter'] ?? [];
  91.         if (\is_array($filter) && \array_key_exists('context', $filter)) {
  92.             $context = $filter['context']['value'];
  93.         } else {
  94.             $context = $request->query->get('context', $this->pool->getDefaultContext());
  95.         }
  97.         $providers = $this->pool->getProvidersByContext($context);
  98.         $provider = $request->query->get('provider');
  100.         // if the context has only one provider, set it into the request
  101.         // so the intermediate provider selection is skipped
  102.         if (1 === \count($providers) && null === $provider) {
  103.             $provider = array_shift($providers)->getName();
  104.             $request->query->set('provider', $provider);
  105.         }
  107.         // if there is a post server error, provider is not posted and in case of
  108.         // multiple providers, it has to be persistent to not being lost
  109.         if (1 < \count($providers) && null !== $provider) {
  110.             $parameters['provider'] = $provider;
  111.         }
  113.         $categoryId = $request->query->get('category');
  115.         if (null !== $this->categoryManager && null !== $this->contextManager && null === $categoryId) {
  116.             $rootCategories = $this->categoryManager->getRootCategoriesForContext($this->contextManager->find($context));
  117.             $rootCategory = current($rootCategories);
  119.             if (false !== $rootCategory) {
  120.                 $categoryId = $rootCategory->getId();
  121.             }
  122.         }
  124.         return array_merge($parameters, [
  125.             'context' => $context,
  126.             'category' => $categoryId,
  127.             'hide_context' => $request->query->getBoolean('hide_context'),
  128.         ]);
  129.     }
  131.     protected function alterNewInstance(object $object): void
  132.     {
  133.         if (!$this->hasRequest()) {
  134.             return;
  135.         }
  137.         $request = $this->getRequest();
  139.         if ($request->isMethod('POST')) {
  140.             $uniqId = $this->getUniqId();
  142.             // TODO: Change to $request->request->all($uniqid)['providerName'] when support for Symfony < 5.1 is dropped.
  143.             $data = $request->request->all()[$uniqId] ?? [];
  144.             \assert(\is_array($data));
  146.             $providerName = $data['providerName'];
  147.         } else {
  148.             $providerName = $request->query->get('provider');
  149.         }
  151.         $context = $request->query->get('context');
  153.         $object->setProviderName($providerName);
  154.         $object->setContext($context);
  156.         $categoryId = $this->getPersistentParameter('category');
  158.         if (null === $this->categoryManager || null === $categoryId) {
  159.             return;
  160.         }
  162.         $category = $this->categoryManager->find($categoryId);
  164.         if (null === $category) {
  165.             return;
  166.         }
  168.         $categoryContext = $category->getContext();
  170.         if (null === $categoryContext || $categoryContext->getId() !== $context) {
  171.             return;
  172.         }
  174.         $object->setCategory($category);
  175.     }
  177.     protected function configureListFields(ListMapper $list): void
  178.     {
  179.         $list
  180.             ->addIdentifier('name')
  181.             ->add('description')
  182.             ->add('enabled')
  183.             ->add('size');
  184.     }
  186.     protected function configureFormFields(FormMapper $form): void
  187.     {
  188.         $media = $this->hasSubject() ? $this->getSubject() : $this->getNewInstance();
  190.         if (null === $media->getProviderName()) {
  191.             return;
  192.         }
  194.         $form->add('providerName', HiddenType::class);
  196.         $form->getFormBuilder()->addModelTransformer(new ProviderDataTransformer($this->pool, $this->getClass()), true);
  198.         $provider = $this->pool->getProvider($media->getProviderName());
  200.         if (null !== $media->getId()) {
  201.             $provider->buildEditForm($form);
  202.         } else {
  203.             $provider->buildCreateForm($form);
  204.         }
  206.         if (null === $this->categoryManager) {
  207.             return;
  208.         }
  210.         $form->add('category', ModelListType::class, [], [
  211.             'link_parameters' => [
  212.                 'context' => $media->getContext(),
  213.                 'hide_context' => true,
  214.                 'mode' => 'tree',
  215.             ],
  216.         ]);
  217.     }
  218. }