vendor/dma/dma_simple_grid/src/Resources/contao/classes/DmaSimpleGrid.php line 100

Open in your IDE?
  1. <?php
  2. /*
  3.  * Copyright DMA GmbH and Janosch Oltmanns
  4.  *
  5.  * For the full copyright and license information, please view the LICENSE
  6.  * file that was distributed with this source code.
  7.  */
  9. namespace DMA;
  11. /**
  12.  * DMA SimpleGrid DCA (tl_content and tl_module)
  13.  *
  14.  * Provide miscellaneous methods that are used by the data configuration arrays.
  15.  *
  16.  * @author Janosch Oltmanns <oltmanns@dma.do>
  17.  */
  18. class DmaSimpleGrid
  19. {
  22.     /**
  23.      * Object instance (Singleton)
  24.      * @var \Input
  25.      */
  26.     protected static $objInstance;
  28.     /**
  29.      * Cache
  30.      * @var array
  31.      */
  32.     protected static $arrCache = array();
  34.     public static function getData()
  35.     {
  36.         if (!isset(static::$arrCache['grid']))
  37.         {
  38.             self::initialize();
  39.         }
  41.         return static::$arrCache['grid'];
  42.     }
  44.     public static function getConfigData($strKey)
  45.     {
  46.         if (!isset(static::$arrCache['grid']))
  47.         {
  48.             self::initialize();
  49.         }
  51.         return static::$arrCache['grid']['config'][$strKey] ?? false;
  52.     }
  54.     public static function hasDmaGridInfos($arrTemplateData)
  55.     {
  56.         $arrCheckableKeys = array
  57.         (
  58.             'dma_simplegrid_columnsettings',
  59.             'dma_simplegrid_offsetsettings',
  60.             'dma_simplegrid_offsetrightsettings',
  61.             'dma_simplegrid_pushsettings',
  62.             'dma_simplegrid_pullsettings'
  63.         );
  65.         $blnHasDmaGridInfos = false;
  67.         foreach ($arrCheckableKeys as $checkableKey)
  68.         {
  69.             if (isset($arrTemplateData[$checkableKey]) && $arrTemplateData[$checkableKey])
  70.             {
  71.                 $blnHasDmaGridInfos = true;
  72.             }
  73.         }
  75.         return $blnHasDmaGridInfos;
  77.     }
  79.     public static function getColumnClasses($arrTemplateData)
  80.     {
  82.         if (isset($arrTemplateData['origId']) && $arrTemplateData['origId'] && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useOwnSettingsByIncludeElements'] ?? false))
  83.         {
  84.             // includiertes Inhaltselement
  85.             $origContentElement = \ContentModel::findById($arrTemplateData['id']);
  86.             if ($origContentElement !== null)
  87.             {
  88.                 $arrTemplateData = $origContentElement->row();
  89.             }
  90.         }
  92.         if (!isset(static::$arrCache['grid']))
  93.         {
  94.             self::initialize();
  95.         }
  97.         $arrConfiguredClasses = array();
  99.         if (isset($arrTemplateData['dma_simplegrid_columnsettings']) && !is_array($arrTemplateData['dma_simplegrid_columnsettings'])) {
  100.             $arrColumnSettings = deserialize($arrTemplateData['dma_simplegrid_columnsettings'], true);
  101.         }
  102.         if (isset($arrTemplateData['dma_simplegrid_offsetsettings']) && !is_array($arrTemplateData['dma_simplegrid_offsetsettings'])) {
  103.             $arrOffsetSettings = deserialize($arrTemplateData['dma_simplegrid_offsetsettings'], true);
  104.         }
  105.         if (isset($arrTemplateData['dma_simplegrid_offsetrightsettings']) && !is_array($arrTemplateData['dma_simplegrid_offsetrightsettings'])) {
  106.             $arrOffsetRightSettings = deserialize($arrTemplateData['dma_simplegrid_offsetrightsettings'], true);
  107.         }
  108.         if (isset($arrTemplateData['dma_simplegrid_pushsettings']) && !is_array($arrTemplateData['dma_simplegrid_pushsettings'])) {
  109.             $arrPushSettings = deserialize($arrTemplateData['dma_simplegrid_pushsettings'], true);
  110.         }
  111.         if (isset($arrTemplateData['dma_simplegrid_pullsettings']) && !is_array($arrTemplateData['dma_simplegrid_pullsettings'])) {
  112.             $arrPullSettings = deserialize($arrTemplateData['dma_simplegrid_pullsettings'], true);
  113.         }
  115.         if (isset($arrColumnSettings) && sizeof($arrColumnSettings) == 1) {
  116.             $arrElementSettings = $arrColumnSettings[0];
  117.             if (is_array($arrElementSettings)) {
  118.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  119.                     if ($varValue) {
  120.                         if ($varValue === 'hide') {
  121.                             $arrConfiguredClasses[] = static::$arrCache['grid']['config']['columns-config'][$columnKey]['hide-class'];
  122.                         } else {
  123.                             $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['column-class'], $varValue);
  124.                         }
  125.                     }
  126.                 }
  127.             }
  128.         }
  130.         if (isset($arrOffsetSettings) && sizeof($arrOffsetSettings) == 1 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useOffset'] ?? false)) {
  131.             $arrElementSettings = $arrOffsetSettings[0];
  132.             if (is_array($arrElementSettings)) {
  133.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  134.                     if ($varValue === 'reset' && isset(static::$arrCache['grid']['config']['hasColumnOffsetReset']) && static::$arrCache['grid']['config']['hasColumnOffsetReset']) {
  135.                         $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['offset-class'], 0);
  136.                     } elseif ($varValue) {
  137.                         $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['offset-class'], $varValue);
  138.                     }
  139.                 }
  140.             }
  141.         }
  143.         if (isset($arrOffsetRightSettings) && sizeof($arrOffsetRightSettings) == 1 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useOffsetRight'] ?? false)) {
  144.             $arrElementSettings = $arrOffsetRightSettings[0];
  145.             if (is_array($arrElementSettings)) {
  146.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  147.                     if ($varValue === 'reset' && isset(static::$arrCache['grid']['config']['hasColumnOffsetRightReset']) && static::$arrCache['grid']['config']['hasColumnOffsetRightReset']) {
  148.                         $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['offset-right-class'], 0);
  149.                     } elseif ($varValue) {
  150.                         $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['offset-right-class'], $varValue);
  151.                     }
  152.                 }
  153.             }
  154.         }
  156.         if (isset($arrPushSettings) && sizeof($arrPushSettings) == 1 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_usePush'] ?? false)) {
  157.             $arrElementSettings = $arrPushSettings[0];
  158.             if (is_array($arrElementSettings)) {
  159.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  160.                     if ($varValue === 'reset' && isset(static::$arrCache['grid']['config']['hasColumnPushReset']) && static::$arrCache['grid']['config']['hasColumnPushReset']) {
  161.                         $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['push-class'], 0);
  162.                     } elseif ($varValue) {
  163.                         $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['push-class'], $varValue);
  164.                     }
  165.                 }
  166.             }
  167.         }
  169.         if (isset($arrPullSettings) && sizeof($arrPullSettings) == 1 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_usePull'] ?? false)) {
  170.             $arrElementSettings = $arrPullSettings[0];
  171.             if (is_array($arrElementSettings)) {
  172.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  173.                     if ($varValue === 'reset' && isset(static::$arrCache['grid']['config']['hasColumnPullReset']) && static::$arrCache['grid']['config']['hasColumnPullReset']) {
  174.                         $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['pull-class'], 0);
  175.                     } elseif ($varValue) {
  176.                         $arrConfiguredClasses[] = sprintf(static::$arrCache['grid']['config']['columns-config'][$columnKey]['pull-class'], $varValue);
  177.                     }
  178.                 }
  179.             }
  180.         }
  182.         if (isset(static::$arrCache['grid']['config']['additional-classes']['columns']) && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useAdditionalColumnClasses'] ?? false)
  183.         ) {
  184.             $arrAdditionalClasses = isset($arrTemplateData['dma_simplegrid_additionalcolumnclasses']) ? deserialize($arrTemplateData['dma_simplegrid_additionalcolumnclasses'], true) : [];
  186.             if (sizeof($arrAdditionalClasses) > 0)
  187.             {
  188.                 foreach ($arrAdditionalClasses as $strClassKey)
  189.                 {
  190.                     $arrConfiguredClasses[] = $strClassKey;
  191.                 }
  192.             }
  193.         }
  195.         if (sizeof($arrConfiguredClasses) > 0 || (isset($arrTemplateData['type']) && $arrTemplateData['type']=="dma_simplegrid_column_start")) {
  196.             if (isset(static::$arrCache['grid']['config']['column-class']) && static::$arrCache['grid']['config']['column-class'])
  197.             {
  198.                 array_insert($arrConfiguredClasses, 0, static::$arrCache['grid']['config']['column-class']);
  199.             }
  200.         }
  203.         $strClasses = implode(' ', $arrConfiguredClasses);
  205.         if (strpos($strClasses, "^") !== false)
  206.         {
  207.             $strClasses = str_replace(" ^", "", $strClasses);
  208.         }
  210.         return $strClasses;
  212.     }
  216.     public static function getSimpleGridInfos($arrRow)
  217.     {
  219.         if (!isset(static::$arrCache['grid']))
  220.         {
  221.             self::initialize();
  222.         }
  224.         $strGridInfo = "";
  226.         if (($arrRow['dma_simplegrid_columnsettings'] ?? false) || ($arrRow['dma_simplegrid_additionalwrapperclasses'] ?? false))
  227.         {
  228.             $strGridInfo .= self::getColumnsShowString($arrRow);
  229.         }
  231.         if ($strGridInfo != "")
  232.         {
  233.             $strGridInfo = '<a href="#" class="tl_gray" style="padding-right:10px; white-space:nowrap; max-width:200px; display:inline-block; overflow:hidden; text-overflow:ellipsis;" title="' . $strGridInfo .'" onclick="return false;">' . $strGridInfo . '</a>';
  234.         }
  236.         return $strGridInfo;
  238.     }
  240.     public static function blockSelectCallback()
  241.     {
  243.         if (!isset(static::$arrCache['grid']))
  244.         {
  245.             self::initialize();
  246.         }
  248.         $arrColumnsSetting = array();
  250.         if (static::$arrCache['grid']['config']['block-config']) {
  251.             foreach (static::$arrCache['grid']['config']['block-config'] as $configName => $arrColumnConfig) {
  252.                 $arrColumnsSetting[$configName] = array
  253.                 (
  254.                     'label' => $arrColumnConfig['name'],
  255.                     'inputType' => 'select',
  256.                     'options' => static::$arrCache['grid']['config']['block-sizes'],
  257.                     'eval' => array('includeBlankOption' => true, 'style' => 'width:115px')
  258.                 );
  259.             }
  260.         }
  262.         return $arrColumnsSetting;
  264.     }
  266.     public static function columnsSelectCallback(\Widget $widget = null)
  267.     {
  268.         if (!isset(static::$arrCache['grid']))
  269.         {
  270.             self::initialize();
  271.         }
  273.         $arrColumnsSetting = array();
  275.         if (static::$arrCache['grid']['config']['columns-config']) {
  276.             foreach (static::$arrCache['grid']['config']['columns-config'] as $configName => $arrColumnConfig) {
  277.                 $options = [];
  279.                 // Add the hide option for column settings
  280.                 if ($widget !== null && $widget->dataContainer->field === 'dma_simplegrid_columnsettings' && isset($arrColumnConfig['hide-class'])) {
  281.                     $options['hide'] = &$GLOBALS['TL_LANG']['MSC']['dma_simplegrid_hidden'];
  282.                 }
  284.                 // Add the reset/zero option for offset/offset-right/push/pull settings
  285.                 if ($widget !== null && (
  286.                     ($widget->dataContainer->field === 'dma_simplegrid_offsetsettings' && isset(static::$arrCache['grid']['config']['hasColumnOffsetReset']) && static::$arrCache['grid']['config']['hasColumnOffsetReset'])
  287.                     || ($widget->dataContainer->field === 'dma_simplegrid_offsetrightsettings' && isset(static::$arrCache['grid']['config']['hasColumnOffsetRightReset']) && static::$arrCache['grid']['config']['hasColumnOffsetRightReset'])
  288.                     || ($widget->dataContainer->field === 'dma_simplegrid_pushsettings' && isset(static::$arrCache['grid']['config']['hasColumnPushReset']) && static::$arrCache['grid']['config']['hasColumnPushReset'])
  289.                     || ($widget->dataContainer->field === 'dma_simplegrid_pullsettings' && isset(static::$arrCache['grid']['config']['hasColumnPullReset']) && static::$arrCache['grid']['config']['hasColumnPullReset'])
  290.                 )) {
  291.                     $options['reset'] = '0 (reset)';
  292.                 }
  294.                 // Add the column sizes
  295.                 foreach (static::$arrCache['grid']['config']['columns-sizes'] as $column) {
  296.                     $options[$column] = $column;
  297.                 }
  299.                 $arrColumnsSetting[$configName] = array
  300.                 (
  301.                     'label' => $arrColumnConfig['name'],
  302.                     'inputType' => 'select',
  303.                     'options' => $options,
  304.                     'eval' => array('includeBlankOption' => true, 'style' => 'width:115px')
  305.                 );
  306.             }
  307.         }
  309.         return $arrColumnsSetting;
  310.     }
  312.     public static function getAdditionalWrapperClasses()
  313.     {
  314.         if (!isset(static::$arrCache['grid']))
  315.         {
  316.             self::initialize();
  317.         }
  319.         return static::$arrCache['grid']['config']['additional-classes']['wrapper'];
  320.     }
  322.     public static function getAdditionalRowClasses()
  323.     {
  325.         if (!isset(static::$arrCache['grid']))
  326.         {
  327.             self::initialize();
  328.         }
  330.         return static::$arrCache['grid']['config']['additional-classes']['row'];
  331.     }
  333.     public static function getAdditionalColumnClasses()
  334.     {
  336.         if (!isset(static::$arrCache['grid']))
  337.         {
  338.             self::initialize();
  339.         }
  341.         return static::$arrCache['grid']['config']['additional-classes']['columns'];
  342.     }
  344.     public static function getColumnsShowString($arrRow)
  345.     {
  346.         $strReturn = "";
  347.         $arrConfiguredClasses = array();
  349.         if (!is_array($arrRow['dma_simplegrid_columnsettings'] ?? null)) {
  350.             $arrColumnSettings = isset($arrRow['dma_simplegrid_columnsettings']) ? deserialize($arrRow['dma_simplegrid_columnsettings'], true) : [];
  351.         }
  352.         if (!is_array($arrRow['dma_simplegrid_offsetsettings'] ?? null)) {
  353.             $arrOffsetSettings = isset($arrRow['dma_simplegrid_offsetsettings']) ? deserialize($arrRow['dma_simplegrid_offsetsettings'], true) : [];
  354.         }
  355.         if (!is_array($arrRow['dma_simplegrid_offsetrightsettings'] ?? null)) {
  356.             $arrOffsetRightSettings = isset($arrRow['dma_simplegrid_offsetrightsettings']) ? deserialize($arrRow['dma_simplegrid_offsetrightsettings'], true) : [];
  357.         }
  358.         if (!is_array($arrRow['dma_simplegrid_pushsettings'] ?? null)) {
  359.             $arrPushSettings = isset($arrRow['dma_simplegrid_pushsettings']) ? deserialize($arrRow['dma_simplegrid_pushsettings'], true) : [];
  360.         }
  361.         if (!is_array($arrRow['dma_simplegrid_pullsettings'] ?? null)) {
  362.             $arrPullSettings = isset($arrRow['dma_simplegrid_pullsettings']) ? deserialize($arrRow['dma_simplegrid_pullsettings'], true) : [];
  363.         }
  364.         if (!is_array($arrRow['dma_simplegrid_additionalcolumnclasses'] ?? null)) {
  365.             $arrAdditionalColumnClassesSettings = isset($arrRow['dma_simplegrid_additionalcolumnclasses']) ? deserialize($arrRow['dma_simplegrid_additionalcolumnclasses'], true) : [];
  366.         }
  367.         if (!is_array($arrRow['dma_simplegrid_additionalrowclasses'] ?? null)) {
  368.             $arrAdditionalRowClassesSettings = isset($arrRow['dma_simplegrid_additionalrowclasses']) ? deserialize($arrRow['dma_simplegrid_additionalrowclasses'], true) : [];
  369.         }
  370.         if (!is_array($arrRow['dma_simplegrid_additionalwrapperclasses'] ?? null)) {
  371.             $arrAdditionalWrapperClassesSettings = isset($arrRow['dma_simplegrid_additionalwrapperclasses']) ? deserialize($arrRow['dma_simplegrid_additionalwrapperclasses'], true) : [];
  372.         }
  374.         if (sizeof($arrColumnSettings) == 1) {
  375.             $arrElementSettings = $arrColumnSettings[0];
  376.             if (is_array($arrElementSettings)) {
  377.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  378.                     if ($varValue && static::$arrCache['grid']['config']['columns-config'][$columnKey]['name']) {
  379.                         $arrConfiguredClasses[] = static::$arrCache['grid']['config']['columns-config'][$columnKey]['name'] . ": " . $varValue;
  380.                     }
  381.                 }
  382.             }
  383.         }
  385.         if (sizeof($arrOffsetSettings) == 1 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useOffset'] ?? false)) {
  386.             $arrElementSettings = $arrOffsetSettings[0];
  387.             if (is_array($arrElementSettings)) {
  388.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  389.                     if ($varValue && static::$arrCache['grid']['config']['columns-config'][$columnKey]['name']) {
  390.                         $arrConfiguredClasses[] = static::$arrCache['grid']['config']['columns-config'][$columnKey]['name'] . "-offset: " . $varValue;
  391.                     }
  392.                 }
  393.             }
  394.         }
  396.         if (sizeof($arrOffsetRightSettings) == 1 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useOffsetRight'] ?? false)) {
  397.             $arrElementSettings = $arrOffsetRightSettings[0];
  398.             if (is_array($arrElementSettings)) {
  399.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  400.                     if ($varValue && static::$arrCache['grid']['config']['columns-config'][$columnKey]['name']) {
  401.                         $arrConfiguredClasses[] = static::$arrCache['grid']['config']['columns-config'][$columnKey]['name'] . "-offset-right: " . $varValue;
  402.                     }
  403.                 }
  404.             }
  405.         }
  407.         if (sizeof($arrPushSettings) == 1 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_usePush'] ?? false)) {
  408.             $arrElementSettings = $arrPushSettings[0];
  409.             if (is_array($arrElementSettings)) {
  410.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  411.                     if ($varValue && static::$arrCache['grid']['config']['columns-config'][$columnKey]['name']) {
  412.                         $arrConfiguredClasses[] = static::$arrCache['grid']['config']['columns-config'][$columnKey]['name'] . "-push: " . $varValue;
  413.                     }
  414.                 }
  415.             }
  416.         }
  418.         if (sizeof($arrPullSettings) == 1 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_usePull'] ?? false)) {
  419.             $arrElementSettings = $arrPullSettings[0];
  420.             if (is_array($arrElementSettings)) {
  421.                 foreach ($arrElementSettings as $columnKey => $varValue) {
  422.                     if ($varValue && static::$arrCache['grid']['config']['columns-config'][$columnKey]['name']) {
  423.                         $arrConfiguredClasses[] = static::$arrCache['grid']['config']['columns-config'][$columnKey]['name'] . "-pull: " . $varValue;
  424.                     }
  425.                 }
  426.             }
  427.         }
  429.         if (sizeof($arrAdditionalColumnClassesSettings) > 0 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useAdditionalColumnClasses'] ?? false))
  430.         {
  431.             if (is_array($arrAdditionalColumnClassesSettings))
  432.             {
  433.                 foreach ($arrAdditionalColumnClassesSettings as $varValue)
  434.                 {
  435.                     $arrConfiguredClasses[] = $varValue;
  436.                 }
  437.             }
  438.         }
  440.         if (sizeof($arrAdditionalRowClassesSettings) > 0 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useAdditionalRowClasses'] ?? false))
  441.         {
  442.             if (is_array($arrAdditionalRowClassesSettings))
  443.             {
  444.                 foreach ($arrAdditionalRowClassesSettings as $varValue)
  445.                 {
  446.                     $arrConfiguredClasses[] = $varValue;
  447.                 }
  448.             }
  449.         }
  451.         if (sizeof($arrAdditionalWrapperClassesSettings) > 0 && ($GLOBALS['TL_CONFIG']['dmaSimpleGrid_useAdditionalWrapperClasses'] ?? false))
  452.         {
  453.             if (is_array($arrAdditionalWrapperClassesSettings))
  454.             {
  455.                 foreach ($arrAdditionalWrapperClassesSettings as $varValue)
  456.                 {
  457.                     $arrConfiguredClasses[] = $varValue;
  458.                 }
  459.             }
  460.         }
  466.         $strReturn = implode('; ', $arrConfiguredClasses);
  468.         return $strReturn;
  470.     }
  472.     private static function initialize()
  473.     {
  475.         if (($GLOBALS['TL_CONFIG']['dmaSimpleGridType'] ?? false) && ($GLOBALS['DMA_SIMPLEGRID_CONFIG'][($GLOBALS['TL_CONFIG']['dmaSimpleGridType'] ?? null)] ?? false))
  476.         {
  477.             static::$arrCache['grid'] = $GLOBALS['DMA_SIMPLEGRID_CONFIG'][$GLOBALS['TL_CONFIG']['dmaSimpleGridType']];
  478.         }
  479.         else
  480.         {
  481.             static::$arrCache['grid'] = $GLOBALS['DMA_SIMPLEGRID_CONFIG'][$GLOBALS['DMA_SIMPLEGRID_FALLBACK']];
  482.         }
  483.     }
  485. }