vendor/easycorp/easyadmin-bundle/src/Configuration/ConfigManager.php line 104

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Configuration;
  5. use EasyCorp\Bundle\EasyAdminBundle\Exception\UndefinedEntityException;
  6. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  7. use Symfony\Contracts\Cache\CacheInterface;
  9. final class ConfigManager
  10. {
  11.     private const CACHE_KEY = 'easyadmin.processed_config';
  13.     /** @var array */
  14.     private $backendConfig;
  15.     private $debug;
  16.     private $propertyAccessor;
  17.     private $cache;
  18.     /** @var array */
  19.     private $originalBackendConfig;
  20.     /** @var ConfigPassInterface[] */
  21.     private $configPasses;
  23.     public function __construct(array $originalBackendConfig, bool $debug, PropertyAccessorInterface $propertyAccessor, CacheInterface $cache)
  24.     {
  25.         $this->originalBackendConfig = $originalBackendConfig;
  26.         $this->debug = $debug;
  27.         $this->propertyAccessor = $propertyAccessor;
  28.         $this->cache = $cache;
  29.     }
  31.     /**
  32.      * @param ConfigPassInterface $configPass
  33.      */
  34.     public function addConfigPass(ConfigPassInterface $configPass)
  35.     {
  36.         $this->configPasses[] = $configPass;
  37.     }
  39.     public function getBackendConfig(string $propertyPath = null)
  40.     {
  41.         $this->loadBackendConfig();
  43.         if (empty($propertyPath)) {
  44.             return $this->backendConfig;
  45.         }
  47.         // turns 'design.menu' into '[design][menu]', the format required by PropertyAccess
  48.         $propertyPath = '['.str_replace('.', '][', $propertyPath).']';
  50.         return $this->propertyAccessor->getValue($this->backendConfig, $propertyPath);
  51.     }
  53.     public function getEntityConfig(string $entityName): array
  54.     {
  55.         $backendConfig = $this->getBackendConfig();
  56.         if (!isset($backendConfig['entities'][$entityName])) {
  57.             throw new UndefinedEntityException(['entity_name' => $entityName]);
  58.         }
  60.         return $backendConfig['entities'][$entityName];
  61.     }
  63.     public function getEntityConfigByClass(string $fqcn): ?array
  64.     {
  65.         $backendConfig = $this->getBackendConfig();
  66.         foreach ($backendConfig['entities'] as $entityName => $entityConfig) {
  67.             if ($entityConfig['class'] === $fqcn) {
  68.                 return $entityConfig;
  69.             }
  70.         }
  72.         return null;
  73.     }
  75.     public function getActionConfig(string $entityName, string $view, string $action): array
  76.     {
  77.         try {
  78.             $entityConfig = $this->getEntityConfig($entityName);
  79.         } catch (\Exception $e) {
  80.             $entityConfig = [];
  81.         }
  83.         return $entityConfig[$view]['actions'][$action] ?? [];
  84.     }
  86.     public function isActionEnabled(string $entityName, string $view, string $action): bool
  87.     {
  88.         $entityConfig = $this->getEntityConfig($entityName);
  90.         return !\in_array($action, $entityConfig['disabled_actions'], true) && \array_key_exists($action, $entityConfig[$view]['actions']);
  91.     }
  93.     /**
  94.      * It processes the given backend configuration to generate the fully
  95.      * processed configuration used in the application.
  96.      *
  97.      * @param array $backendConfig
  98.      *
  99.      * @return array
  100.      */
  101.     private function doProcessConfig($backendConfig): array
  102.     {
  103.         foreach ($this->configPasses as $configPass) {
  104.             $backendConfig = $configPass->process($backendConfig);
  105.         }
  107.         return $backendConfig;
  108.     }
  110.     private function loadBackendConfig(): array
  111.     {
  112.         if (null !== $this->backendConfig) {
  113.             return $this->backendConfig;
  114.         }
  116.         if (true === $this->debug) {
  117.             return $this->backendConfig = $this->doProcessConfig($this->originalBackendConfig);
  118.         }
  120.         return $this->backendConfig = $this->cache->get(self::CACHE_KEY, function () {
  121.             return $this->doProcessConfig($this->originalBackendConfig);
  122.         });
  123.     }
  124. }