vendor/netzmacht/contao-toolkit/src/Dca/Manager.php line 74

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Netzmacht\Contao\Toolkit\Dca;
  7. use Netzmacht\Contao\Toolkit\Assertion\Assertion;
  8. use Netzmacht\Contao\Toolkit\Dca\Formatter\Formatter;
  9. use Netzmacht\Contao\Toolkit\Dca\Formatter\FormatterFactory;
  11. /**
  12.  * Data container definition manager.
  13.  */
  14. final class Manager implements DcaManager
  15. {
  16.     /**
  17.      * Data definition cache.
  18.      *
  19.      * @var Definition[]
  20.      */
  21.     private $definitions = [];
  23.     /**
  24.      * Data definition formatter cache.
  25.      *
  26.      * @var Formatter[]
  27.      */
  28.     private $formatter = [];
  30.     /**
  31.      * The data definition array loader.
  32.      *
  33.      * @var DcaLoader
  34.      */
  35.     private $loader;
  37.     /**
  38.      * FormatterFactory.
  39.      *
  40.      * @var FormatterFactory
  41.      */
  42.     private $formatterFactory;
  44.     /**
  45.      * @param DcaLoader        $loader           The data definition array loader.
  46.      * @param FormatterFactory $formatterFactory Formatter factory.
  47.      */
  48.     public function __construct(DcaLoader $loader, FormatterFactory $formatterFactory)
  49.     {
  50.         $this->loader           = $loader;
  51.         $this->formatterFactory = $formatterFactory;
  52.     }
  54.     /**
  55.      * Get a data container definition.
  56.      *
  57.      * @param string $name    The data definition name.
  58.      * @param bool   $noCache If true not the cached version is loaded.
  59.      *
  60.      * @SuppressWarnings(PHPMD.Superglobals)
  61.      */
  62.     public function getDefinition(string $name, bool $noCache = false): Definition
  63.     {
  64.         if ($noCache) {
  65.             $this->loader->loadLanguageFile($name, null, $noCache);
  66.             $this->loader->loadDataContainer($name, $noCache);
  68.             $this->assertValidDca($name);
  70.             return new Definition($name, $GLOBALS['TL_DCA'][$name]);
  71.         }
  73.         if (! isset($this->definitions[$name])) {
  74.             $this->loader->loadLanguageFile($name);
  75.             $this->loader->loadDataContainer($name);
  77.             $this->assertValidDca($name);
  79.             $this->definitions[$name] = new Definition($name, $GLOBALS['TL_DCA'][$name]);
  80.         }
  82.         return $this->definitions[$name];
  83.     }
  85.     /**
  86.      * Get a formatter for a definition.
  87.      *
  88.      * @param string $name Definition or name.
  89.      */
  90.     public function getFormatter(string $name): Formatter
  91.     {
  92.         if (! isset($this->formatter[$name])) {
  93.             $definition             = $this->getDefinition($name);
  94.             $this->formatter[$name] = $this->formatterFactory->createFormatterFor($definition);
  95.         }
  97.         return $this->formatter[$name];
  98.     }
  100.     /**
  101.      * Assert that a valid dca is loaded.
  102.      *
  103.      * @param string $name Dca name.
  104.      *
  105.      * @SuppressWarnings(PHPMD.Superglobals)
  106.      */
  107.     protected function assertValidDca(string $name): void
  108.     {
  109.         Assertion::keyExists($GLOBALS['TL_DCA'], $name);
  110.         Assertion::isArray($GLOBALS['TL_DCA'][$name]);
  111.     }
  112. }