vendor/contao/core-bundle/src/Resources/contao/library/Contao/DcaLoader.php line 75

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of Contao.
  5.  *
  6.  * (c) Leo Feyer
  7.  *
  8.  * @license LGPL-3.0-or-later
  9.  */
  11. namespace Contao;
  13. /**
  14.  * Loads a set of DCA files
  15.  *
  16.  * The class loads the DCA files of a certain table and stores a combined
  17.  * version in the cache directory.
  18.  *
  19.  * Usage:
  20.  *
  21.  *     $dca = new DcaLoader('tl_user');
  22.  *     $dca->load();
  23.  */
  24. class DcaLoader extends Controller
  25. {
  26.     /**
  27.      * @var array
  28.      */
  29.     protected static $arrLoaded = array();
  31.     /**
  32.      * Table name
  33.      * @var string
  34.      */
  35.     protected $strTable;
  37.     /**
  38.      * Store the table name
  39.      *
  40.      * @param string $strTable The table name
  41.      *
  42.      * @throws \Exception If $strTable is empty
  43.      */
  44.     public function __construct($strTable)
  45.     {
  46.         if (!$strTable)
  47.         {
  48.             throw new \Exception('The table name must not be empty');
  49.         }
  51.         if (Validator::isInsecurePath($strTable))
  52.         {
  53.             throw new \InvalidArgumentException('The table name contains invalid characters');
  54.         }
  56.         parent::__construct();
  58.         $this->strTable = $strTable;
  59.     }
  61.     /**
  62.      * Load a set of DCA files
  63.      *
  64.      * @param boolean $blnNoCache If true, the cache will be bypassed
  65.      */
  66.     public function load($blnNoCache=false)
  67.     {
  68.         if (\func_num_args() > 0)
  69.         {
  70.             trigger_deprecation('contao/core-bundle', '4.13', 'Calling "%s" with the $blnNoCache parameter has been deprecated and will no longer work in Contao 5.0.', __METHOD__);
  71.         }
  73.         try
  74.         {
  75.             $this->loadDcaFiles($blnNoCache);
  76.         }
  77.         catch (\Throwable $e)
  78.         {
  79.             unset(static::$arrLoaded['dcaFiles'][$this->strTable]);
  81.             throw $e;
  82.         }
  83.     }
  85.     /**
  86.      * Load the DCA files
  87.      *
  88.      * @param boolean $blnNoCache
  89.      */
  90.     private function loadDcaFiles($blnNoCache)
  91.     {
  92.         // Return if the data has been loaded already
  93.         if (!$blnNoCache && isset(static::$arrLoaded['dcaFiles'][$this->strTable]))
  94.         {
  95.             return;
  96.         }
  98.         static::$arrLoaded['dcaFiles'][$this->strTable] = true; // see #6145
  100.         $strCacheDir = System::getContainer()->getParameter('kernel.cache_dir');
  102.         // Try to load from cache
  103.         if (file_exists($strCacheDir . '/contao/dca/' . $this->strTable . '.php'))
  104.         {
  105.             include $strCacheDir . '/contao/dca/' . $this->strTable . '.php';
  106.         }
  107.         else
  108.         {
  109.             try
  110.             {
  111.                 $files = System::getContainer()->get('contao.resource_locator')->locate('dca/' . $this->strTable . '.php', null, false);
  112.             }
  113.             catch (\InvalidArgumentException $e)
  114.             {
  115.                 $files = array();
  116.             }
  118.             foreach ($files as $file)
  119.             {
  120.                 include $file;
  121.             }
  122.         }
  124.         // Set the ptable dynamically
  125.         $this->setDynamicPTable();
  127.         // HOOK: allow loading custom settings
  128.         if (isset($GLOBALS['TL_HOOKS']['loadDataContainer']) && \is_array($GLOBALS['TL_HOOKS']['loadDataContainer']))
  129.         {
  130.             foreach ($GLOBALS['TL_HOOKS']['loadDataContainer'] as $callback)
  131.             {
  132.                 $this->import($callback[0]);
  133.                 $this->{$callback[0]}->{$callback[1]}($this->strTable);
  134.             }
  135.         }
  137.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  139.         // Local configuration file
  140.         if (file_exists($projectDir . '/system/config/dcaconfig.php'))
  141.         {
  142.             trigger_deprecation('contao/core-bundle', '4.3', 'Using the "dcaconfig.php" file has been deprecated and will no longer work in Contao 5.0. Create custom DCA files in the "contao/dca" folder instead.');
  143.             include $projectDir . '/system/config/dcaconfig.php';
  144.         }
  146.         $this->addDefaultLabels($blnNoCache);
  147.     }
  149.     /**
  150.      * Add the default labels (see #509)
  151.      *
  152.      * @param boolean $blnNoCache
  153.      */
  154.     private function addDefaultLabels($blnNoCache)
  155.     {
  156.         // Operations
  157.         foreach (array('global_operations', 'operations') as $key)
  158.         {
  159.             if (!isset($GLOBALS['TL_DCA'][$this->strTable]['list'][$key]))
  160.             {
  161.                 continue;
  162.             }
  164.             foreach ($GLOBALS['TL_DCA'][$this->strTable]['list'][$key] as $k=>&$v)
  165.             {
  166.                 if (\is_array($v) && \array_key_exists('label', $v))
  167.                 {
  168.                     continue;
  169.                 }
  171.                 if (isset($GLOBALS['TL_LANG'][$this->strTable][$k]) || !isset($GLOBALS['TL_LANG']['DCA'][$k]))
  172.                 {
  173.                     $v['label'] = &$GLOBALS['TL_LANG'][$this->strTable][$k];
  174.                 }
  175.                 elseif (isset($GLOBALS['TL_LANG']['DCA'][$k]))
  176.                 {
  177.                     $v['label'] = &$GLOBALS['TL_LANG']['DCA'][$k];
  178.                 }
  179.             }
  181.             unset($v);
  182.         }
  184.         // Fields
  185.         if (isset($GLOBALS['TL_DCA'][$this->strTable]['fields']))
  186.         {
  187.             foreach ($GLOBALS['TL_DCA'][$this->strTable]['fields'] as $k=>&$v)
  188.             {
  189.                 if (isset($v['label']))
  190.                 {
  191.                     continue;
  192.                 }
  194.                 $v['label'] = &$GLOBALS['TL_LANG'][$this->strTable][$k];
  195.             }
  197.             unset($v);
  198.         }
  199.     }
  201.     /**
  202.      * Sets the parent table for the current table, if enabled and not set.
  203.      */
  204.     private function setDynamicPTable(): void
  205.     {
  206.         if (!($GLOBALS['TL_DCA'][$this->strTable]['config']['dynamicPtable'] ?? null) || !isset($GLOBALS['BE_MOD']) || isset($GLOBALS['TL_DCA'][$this->strTable]['config']['ptable']))
  207.         {
  208.             return;
  209.         }
  211.         if (!$do = Input::get('do'))
  212.         {
  213.             return;
  214.         }
  216.         foreach (array_merge(...array_values($GLOBALS['BE_MOD'])) as $key => $module)
  217.         {
  218.             if ($do !== $key || !isset($module['tables']) || !\is_array($module['tables']))
  219.             {
  220.                 continue;
  221.             }
  223.             foreach ($module['tables'] as $table)
  224.             {
  225.                 Controller::loadDataContainer($table);
  226.                 $ctable = $GLOBALS['TL_DCA'][$table]['config']['ctable'] ?? array();
  228.                 if (\in_array($this->strTable, $ctable, true))
  229.                 {
  230.                     $GLOBALS['TL_DCA'][$this->strTable]['config']['ptable'] = $table;
  232.                     return;
  233.                 }
  234.             }
  235.         }
  236.     }
  237. }
  239. class_alias(DcaLoader::class, 'DcaLoader');