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

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.  * @author Leo Feyer <https://github.com/leofeyer>
  25.  */
  26. class DcaLoader extends Controller
  27. {
  28.     /**
  29.      * @var array
  30.      */
  31.     protected static $arrLoaded = array();
  33.     /**
  34.      * Table name
  35.      * @var string
  36.      */
  37.     protected $strTable;
  39.     /**
  40.      * Store the table name
  41.      *
  42.      * @param string $strTable The table name
  43.      *
  44.      * @throws \Exception If $strTable is empty
  45.      */
  46.     public function __construct($strTable)
  47.     {
  48.         if (!$strTable)
  49.         {
  50.             throw new \Exception('The table name must not be empty');
  51.         }
  53.         if (Validator::isInsecurePath($strTable))
  54.         {
  55.             throw new \InvalidArgumentException('The table name contains invalid characters');
  56.         }
  58.         parent::__construct();
  60.         $this->strTable = $strTable;
  61.     }
  63.     /**
  64.      * Load a set of DCA files
  65.      *
  66.      * @param boolean $blnNoCache If true, the cache will be bypassed
  67.      */
  68.     public function load($blnNoCache=false)
  69.     {
  70.         $this->loadDcaFiles($blnNoCache);
  71.     }
  73.     /**
  74.      * Load the DCA files
  75.      *
  76.      * @param boolean $blnNoCache
  77.      */
  78.     private function loadDcaFiles($blnNoCache)
  79.     {
  80.         // Return if the data has been loaded already
  81.         if (!$blnNoCache && isset(static::$arrLoaded['dcaFiles'][$this->strTable]))
  82.         {
  83.             return;
  84.         }
  86.         static::$arrLoaded['dcaFiles'][$this->strTable] = true; // see #6145
  88.         $strCacheDir = System::getContainer()->getParameter('kernel.cache_dir');
  90.         // Try to load from cache
  91.         if (file_exists($strCacheDir . '/contao/dca/' . $this->strTable . '.php'))
  92.         {
  93.             include $strCacheDir . '/contao/dca/' . $this->strTable . '.php';
  94.         }
  95.         else
  96.         {
  97.             try
  98.             {
  99.                 $files = System::getContainer()->get('contao.resource_locator')->locate('dca/' . $this->strTable . '.php', null, false);
  100.             }
  101.             catch (\InvalidArgumentException $e)
  102.             {
  103.                 $files = array();
  104.             }
  106.             foreach ($files as $file)
  107.             {
  108.                 include $file;
  109.             }
  110.         }
  112.         // HOOK: allow to load custom settings
  113.         if (isset($GLOBALS['TL_HOOKS']['loadDataContainer']) && \is_array($GLOBALS['TL_HOOKS']['loadDataContainer']))
  114.         {
  115.             foreach ($GLOBALS['TL_HOOKS']['loadDataContainer'] as $callback)
  116.             {
  117.                 $this->import($callback[0]);
  118.                 $this->{$callback[0]}->{$callback[1]}($this->strTable);
  119.             }
  120.         }
  122.         $projectDir = System::getContainer()->getParameter('kernel.project_dir');
  124.         // Local configuration file
  125.         if (file_exists($projectDir . '/system/config/dcaconfig.php'))
  126.         {
  127.             @trigger_error('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.', E_USER_DEPRECATED);
  128.             include $projectDir . '/system/config/dcaconfig.php';
  129.         }
  131.         $this->addDefaultLabels($blnNoCache);
  132.     }
  134.     /**
  135.      * Add the default labels (see #509)
  136.      *
  137.      * @param boolean $blnNoCache
  138.      */
  139.     private function addDefaultLabels($blnNoCache)
  140.     {
  141.         // Operations
  142.         foreach (array('global_operations', 'operations') as $key)
  143.         {
  144.             if (!isset($GLOBALS['TL_DCA'][$this->strTable]['list'][$key]))
  145.             {
  146.                 continue;
  147.             }
  149.             foreach ($GLOBALS['TL_DCA'][$this->strTable]['list'][$key] as $k=>&$v)
  150.             {
  151.                 if (isset($v['label']))
  152.                 {
  153.                     continue;
  154.                 }
  156.                 if (isset($GLOBALS['TL_LANG'][$this->strTable][$k]) || !isset($GLOBALS['TL_LANG']['DCA'][$k]))
  157.                 {
  158.                     $v['label'] = &$GLOBALS['TL_LANG'][$this->strTable][$k];
  159.                 }
  160.                 elseif (isset($GLOBALS['TL_LANG']['DCA'][$k]))
  161.                 {
  162.                     $v['label'] = &$GLOBALS['TL_LANG']['DCA'][$k];
  163.                 }
  164.             }
  166.             unset($v);
  167.         }
  169.         // Fields
  170.         if (isset($GLOBALS['TL_DCA'][$this->strTable]['fields']))
  171.         {
  172.             foreach ($GLOBALS['TL_DCA'][$this->strTable]['fields'] as $k=>&$v)
  173.             {
  174.                 if (isset($v['label']))
  175.                 {
  176.                     continue;
  177.                 }
  179.                 $v['label'] = &$GLOBALS['TL_LANG'][$this->strTable][$k];
  180.             }
  182.             unset($v);
  183.         }
  184.     }
  185. }
  187. class_alias(DcaLoader::class, 'DcaLoader');