vendor/sonata-project/admin-bundle/src/Twig/GlobalVariables.php line 80

Open in your IDE?
  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\AdminBundle\Twig;
  16. use Sonata\AdminBundle\Admin\Pool;
  17. use Symfony\Component\DependencyInjection\ContainerInterface;
  18. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  20. /**
  21.  * @final since sonata-project/admin-bundle 3.52
  22.  *
  23.  * NEXT_MAJOR: Remove this class.
  24.  *
  25.  * @deprecated since sonata-project/admin-bundle 3.83, will be removed in 4.0.
  26.  *
  27.  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  28.  */
  29. class GlobalVariables
  30. {
  31.     /**
  32.      * @var ContainerInterface
  33.      *
  34.      * @deprecated since sonata-project/admin-bundle 3.5, will be removed in 4.0.
  35.      * NEXT_MAJOR : remove this property
  36.      */
  37.     protected $container;
  39.     /**
  40.      * @var Pool
  41.      */
  42.     protected $adminPool;
  44.     /**
  45.      * @var string|null
  46.      */
  47.     private $mosaicBackground;
  49.     /**
  50.      * @param ContainerInterface|Pool $adminPool
  51.      */
  52.     public function __construct($adminPool, ?string $mosaicBackground = null)
  53.     {
  54.         $this->mosaicBackground = $mosaicBackground;
  56.         // NEXT_MAJOR : remove this block and set adminPool from parameter.
  57.         if ($adminPool instanceof ContainerInterface) {
  58.             @trigger_error(sprintf(
  59.                 'Using an instance of %s is deprecated since version 3.5 and will be removed in 4.0. Use %s instead.',
  60.                 ContainerInterface::class,
  61.                 Pool::class
  62.             ), \E_USER_DEPRECATED);
  64.             /** @psalm-suppress UndefinedMethod */
  65.             $adminPool = $adminPool->get('sonata.admin.pool');
  66.         }
  68.         if ($adminPool instanceof Pool) {
  69.             $this->adminPool = $adminPool;
  71.             return;
  72.         }
  74.         throw new \InvalidArgumentException(sprintf('$adminPool should be an instance of %s', Pool::class));
  75.     }
  77.     /**
  78.      * @return Pool
  79.      */
  80.     public function getAdminPool()
  81.     {
  82.         if ('sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
  83.             @trigger_error(sprintf(
  84.                 'Method "%s()" is deprecated since sonata-project/admin-bundle 3.83 and will be removed in version 4.0.',
  85.                 __METHOD__
  86.             ), \E_USER_DEPRECATED);
  87.         }
  89.         return $this->adminPool;
  90.     }
  92.     /**
  93.      * @param string $code
  94.      * @param string $action
  95.      * @param array  $parameters
  96.      * @param int    $referenceType
  97.      *
  98.      * @return string
  99.      */
  100.     public function url($code, $action, $parameters = [], $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)
  101.     {
  102.         @trigger_error(sprintf(
  103.             'Method "%s()" is deprecated since sonata-project/admin-bundle 3.83 and will be removed in version 4.0.',
  104.             __METHOD__
  105.         ), \E_USER_DEPRECATED);
  107.         [$action, $code] = $this->getCodeAction($code, $action);
  109.         return $this->getAdminPool()->getAdminByAdminCode($code)->generateUrl($action, $parameters, $referenceType);
  110.     }
  112.     /**
  113.      * @param string $code
  114.      * @param string $action
  115.      * @param object $object
  116.      * @param array  $parameters
  117.      * @param int    $referenceType
  118.      *
  119.      * @return string
  120.      */
  121.     public function objectUrl($code, $action, $object, $parameters = [], $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)
  122.     {
  123.         @trigger_error(sprintf(
  124.             'Method "%s()" is deprecated since sonata-project/admin-bundle 3.83 and will be removed in version 4.0.',
  125.             __METHOD__
  126.         ), \E_USER_DEPRECATED);
  128.         [$action, $code] = $this->getCodeAction($code, $action);
  130.         return $this->getAdminPool()->getAdminByAdminCode($code)->generateObjectUrl($action, $object, $parameters, $referenceType);
  131.     }
  133.     public function getMosaicBackground(): ?string
  134.     {
  135.         @trigger_error(sprintf(
  136.             'Method "%s()" is deprecated since sonata-project/admin-bundle 3.83 and will be removed in version 4.0.'
  137.             .' Use "sonata_config.getOption(\'mosaic_background\')" instead.',
  138.             __METHOD__
  139.         ), \E_USER_DEPRECATED);
  141.         return $this->mosaicBackground;
  142.     }
  144.     /**
  145.      * @return string[]
  146.      */
  147.     private function getCodeAction(string $code, string $action): array
  148.     {
  149.         if ($pipe = strpos($code, '|')) {
  150.             // convert code=sonata.page.admin.page|sonata.page.admin.snapshot, action=list
  151.             // to => sonata.page.admin.page|sonata.page.admin.snapshot.list
  152.             $action = sprintf('%s.%s', $code, $action);
  153.             $code = substr($code, 0, $pipe);
  154.         }
  156.         return [$action, $code];
  157.     }
  158. }