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

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.         $this->loadDcaFiles($blnNoCache);
  69.     }
  71.     /**
  72.      * Load the DCA files
  73.      *
  74.      * @param boolean $blnNoCache
  75.      */
  76.     private function loadDcaFiles($blnNoCache)
  77.     {
  78.         // Return if the data has been loaded already
  79.         if (!$blnNoCache && isset(static::$arrLoaded['dcaFiles'][$this->strTable]))
  80.         {
  81.             return;
  82.         }
  84.         static::$arrLoaded['dcaFiles'][$this->strTable] = true; // see #6145
  86.         $strCacheDir = System::getContainer()->getParameter('kernel.cache_dir');
  88.         // Try to load from cache
  89.         if (file_exists($strCacheDir . '/contao/dca/' . $this->strTable . '.php'))
  90.         {
  91.             include $strCacheDir . '/contao/dca/' . $this->strTable . '.php';
  92.         }
  93.         else
  94.         {
  95.             try
  96.             {
  97.                 $files = System::getContainer()->get('contao.resource_locator')->locate('dca/' . $this->strTable . '.php', null, false);
  98.             }
  99.             catch (\InvalidArgumentException $e)
  100.             {
  101.                 $files = array();
  102.             }
  104.             foreach ($files as $file)
  105.             {
  106.                 include $file;
  107.             }
  108.         }
  110.         // Set the ptable dynamically
  111.         $this->setDynamicPTable();
  113.         // HOOK: allow loading custom settings
  114.         if (isset($GLOBALS['TL_HOOKS']['loadDataContainer']) && \is_array($GLOBALS['TL_HOOKS']['loadDataContainer']))
  115.         {
  116.             foreach ($GLOBALS['TL_HOOKS']['loadDataContainer'] as $callback)
  117.             {
  118.                 $this->import($callback[0]);
  119.                 $this->{$callback[0]}->{$callback[1]}($this->strTable);
  120.             }
  121.         }
  123.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  125.         // Local configuration file
  126.         if (file_exists($projectDir . '/system/config/dcaconfig.php'))
  127.         {
  128.             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.');
  129.             include $projectDir . '/system/config/dcaconfig.php';
  130.         }
  132.         $this->addDefaultLabels($blnNoCache);
  133.     }
  135.     /**
  136.      * Add the default labels (see #509)
  137.      *
  138.      * @param boolean $blnNoCache
  139.      */
  140.     private function addDefaultLabels($blnNoCache)
  141.     {
  142.         // Operations
  143.         foreach (array('global_operations', 'operations') as $key)
  144.         {
  145.             if (!isset($GLOBALS['TL_DCA'][$this->strTable]['list'][$key]))
  146.             {
  147.                 continue;
  148.             }
  150.             foreach ($GLOBALS['TL_DCA'][$this->strTable]['list'][$key] as $k=>&$v)
  151.             {
  152.                 if (isset($v['label']))
  153.                 {
  154.                     continue;
  155.                 }
  157.                 if (isset($GLOBALS['TL_LANG'][$this->strTable][$k]) || !isset($GLOBALS['TL_LANG']['DCA'][$k]))
  158.                 {
  159.                     $v['label'] = &$GLOBALS['TL_LANG'][$this->strTable][$k];
  160.                 }
  161.                 elseif (isset($GLOBALS['TL_LANG']['DCA'][$k]))
  162.                 {
  163.                     $v['label'] = &$GLOBALS['TL_LANG']['DCA'][$k];
  164.                 }
  165.             }
  167.             unset($v);
  168.         }
  170.         // Fields
  171.         if (isset($GLOBALS['TL_DCA'][$this->strTable]['fields']))
  172.         {
  173.             foreach ($GLOBALS['TL_DCA'][$this->strTable]['fields'] as $k=>&$v)
  174.             {
  175.                 if (isset($v['label']))
  176.                 {
  177.                     continue;
  178.                 }
  180.                 $v['label'] = &$GLOBALS['TL_LANG'][$this->strTable][$k];
  181.             }
  183.             unset($v);
  184.         }
  185.     }
  187.     /**
  188.      * Sets the parent table for the current table, if enabled and not set.
  189.      */
  190.     private function setDynamicPTable(): void
  191.     {
  192.         if (!($GLOBALS['TL_DCA'][$this->strTable]['config']['dynamicPtable'] ?? null) || !isset($GLOBALS['BE_MOD']))
  193.         {
  194.             return;
  195.         }
  197.         if (!$do = Input::get('do'))
  198.         {
  199.             return;
  200.         }
  202.         foreach (array_merge(...array_values($GLOBALS['BE_MOD'])) as $key => $module)
  203.         {
  204.             if ($do !== $key || !isset($module['tables']) || !\is_array($module['tables']))
  205.             {
  206.                 continue;
  207.             }
  209.             foreach ($module['tables'] as $table)
  210.             {
  211.                 Controller::loadDataContainer($table);
  212.                 $ctable = $GLOBALS['TL_DCA'][$table]['config']['ctable'] ?? array();
  214.                 if (\in_array($this->strTable, $ctable, true))
  215.                 {
  216.                     $GLOBALS['TL_DCA'][$this->strTable]['config']['ptable'] = $table;
  218.                     return;
  219.                 }
  220.             }
  221.         }
  222.     }
  223. }
  225. class_alias(DcaLoader::class, 'DcaLoader');