Merge pull request #77 from oveleon/develop

Develop
oveleon · Feb 15, 2023 · 2b4cd96 · 2b4cd96
2 parents 6e25460 + 83111a6
commit 2b4cd96
Show file tree

Hide file tree

Showing 9 changed files with 91 additions and 8 deletions.
diff --git a/composer.json b/composer.json
@@ -47,7 +47,7 @@
   },
   "extra":{
     "branch-alias": {
-      "dev-master": "3.0.x-dev"
+      "dev-master": "3.1.x-dev"
     },
     "contao-manager-plugin": "Oveleon\\ContaoComponentStyleManager\\ContaoManager\\Plugin"
   }

diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
@@ -42,3 +42,13 @@ A special feature is that CSS groups can also be used as template variables via
 
 ### Example css group:
 ![Manage Groups: Image 1](https://www.oveleon.de/share/github-assets/contao-component-style-manager/2.0/groups-edit.png)
+
+# Hide group titles
+Since version 3.1, the group titles will be shown above the StyleManager widget
+
+To disabled showing the group title, you can use the following configuration:
+```yaml
+# config.yaml
+contao_component_style_manager:
+    show_group_title: false
+```
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -26,6 +26,9 @@ public function getConfigTreeBuilder()
                 ->booleanNode('strict')
                     ->defaultFalse()
                 ->end()
+                ->booleanNode('show_group_title')
+                    ->defaultTrue()
+                ->end()
             ->end()
         ;
 

diff --git a/src/DependencyInjection/ContaoComponentStyleManagerExtension.php b/src/DependencyInjection/ContaoComponentStyleManagerExtension.php
@@ -24,5 +24,6 @@ public function load(array $configs, ContainerBuilder $container)
 
         $container->setParameter('contao_component_style_manager.use_bundle_config', $config['use_bundle_config']);
         $container->setParameter('contao_component_style_manager.strict', $config['strict']);
+        $container->setParameter('contao_component_style_manager.show_group_title', $config['show_group_title']);
     }
 }
diff --git a/src/Resources/public/stylemanager.css b/src/Resources/public/stylemanager.css
diff --git a/src/Resources/public/stylemanager.css.map b/src/Resources/public/stylemanager.css.map
diff --git a/src/Resources/public/stylemanager.scss b/src/Resources/public/stylemanager.scss
@@ -22,6 +22,11 @@
       margin-bottom: 15px;
     }
 
+    .sm-group-title {
+      margin-top: 1rem;
+      padding-bottom: .5rem;
+    }
+
     .no_styles{
       min-height: auto;
 

diff --git a/src/StyleManager/Styles.php b/src/StyleManager/Styles.php
@@ -26,6 +26,11 @@ class Styles
      */
     private ?array $currGroups = null;
 
+    /**
+     * Excluded groups
+     */
+    private ?array $exclGroups = null;
+
     /**
      * Initialize the object
      */
@@ -55,6 +60,11 @@ public function get($identifier, $arrGroups=null): string
         {
             $collection = array();
 
+            if(null !== $this->exclGroups)
+            {
+                $this->removeExcludedGroups($arrGroups);
+            }
+
             foreach ($arrGroups as $groupAlias)
             {
                 if($value = $this->getGroupValue($this->styles[ $identifier ][ $groupAlias ] ?? null))
@@ -75,7 +85,17 @@ public function get($identifier, $arrGroups=null): string
     public function prepare($identifier, $arrGroups=null): Styles
     {
         $this->currIdentifier = $identifier;
-        $this->currGroups = $arrGroups;
+        $this->currGroups     = $arrGroups;
+
+        return $this;
+    }
+
+    /**
+     * Exclude css classes
+     */
+    public function exclude(?array $exclGroups=null): Styles
+    {
+        $this->exclGroups = $exclGroups;
 
         return $this;
     }
@@ -118,6 +138,11 @@ public function format(string $format, string $method=''): string
                     }
                 }
 
+                if(null !== $this->exclGroups)
+                {
+                    $arrValues = array_diff($arrValues, $this->exclGroups);
+                }
+
                 if($arrValues !== null && $jsonValue = json_encode($arrValues))
                 {
                     return sprintf($format, $jsonValue);
@@ -151,6 +176,11 @@ private function getCategoryValues($arrVariables): array
     {
         $arrValues = [];
 
+        if(null !== $this->exclGroups)
+        {
+            $this->removeExcludedGroups($arrVariables);
+        }
+
         foreach ($arrVariables as $alias => $arrVariable)
         {
             $arrValues[] = $this->getGroupValue($arrVariable);
@@ -187,4 +217,23 @@ private function parseValueType($strValue)
 
         return $strValue;
     }
+
+    /**
+     * Removes excluded groups
+     */
+    private function removeExcludedGroups(array &$currGroups): void
+    {
+        foreach ($this->exclGroups as $exclude)
+        {
+            if (array_key_exists($exclude, $currGroups))
+            {
+                unset($currGroups[$exclude]);
+            }
+            // in case the excluded group is a value -> when a group was passed
+            else if (in_array($exclude, $currGroups))
+            {
+                $currGroups = array_diff($currGroups, [$exclude]);
+            }
+        }
+    }
 }
diff --git a/src/Widget/ComponentStyleSelect.php b/src/Widget/ComponentStyleSelect.php
@@ -80,6 +80,9 @@ public function generate()
         // Restore default values
         $this->varValue = StyleManager::deserializeValues($this->varValue);
 
+        // Show group title
+        $blnShowGroupTitle = System::getContainer()->getParameter('contao_component_style_manager.show_group_title');
+
         // Prepare group fields
         foreach($arrObjStyleGroups as $objStyleGroup)
         {
@@ -201,10 +204,11 @@ public function generate()
             if(!in_array($collectionAlias, array_keys($arrCollection)))
             {
                 $arrCollection[ $collectionAlias ] = array(
-                    'label'  => $arrArchives[ $objStyleGroup->pid ]['title'],
-                    'desc'   => $arrArchives[ $objStyleGroup->pid ]['desc'],
-                    'group'  => $groupAlias,
-                    'fields' => array()
+                    'label'      => $arrArchives[ $objStyleGroup->pid ]['title'],
+                    'desc'       => $arrArchives[ $objStyleGroup->pid ]['desc'],
+                    'group'      => $groupAlias,
+                    'groupTitle' => $arrArchives[ $objStyleGroup->pid ]['group'] ?? null,
+                    'fields'     => array()
                 );
             }
 
@@ -250,6 +254,7 @@ public function generate()
         {
             $arrNavigation = array();
             $arrContent = array();
+            $groupTitle = null;
 
             $i = 0;
 
@@ -282,6 +287,12 @@ public function generate()
                     implode("", $group['fields'])
                 );
 
+                // Set group title if it exists
+                if ($blnShowGroupTitle && null !== $group['groupTitle'])
+                {
+                    $groupTitle = '<h4 class="sm-group-title">' . $group['groupTitle'] . '</h4>';
+                }
+
                 $i++;
             }
 
@@ -291,7 +302,7 @@ public function generate()
                 $arrNavigation[0] = str_replace("><label", "checked><label", $arrNavigation[0]);
             }
 
-            $arrSections[] = '<div class="tab-container" id="' . $groupAlias . '">' . implode("", $arrNavigation) . implode("", $arrContent) . '</div>';
+            $arrSections[] = '<div class="tab-container" id="' . $groupAlias . '">' . $groupTitle . implode("", $arrNavigation) . implode("", $arrContent) . '</div>';
         }
 
 		return implode("", $arrSections);