fix output channels to work properly with classification stores (#115)

pimcore · Apr 19, 2024 · 62e4742 · 62e4742
1 parent a50eeca
commit 62e4742
Show file tree

Hide file tree

Showing 10 changed files with 84 additions and 16 deletions.
diff --git a/doc/classificationstore.md b/doc/classificationstore.md
@@ -16,7 +16,10 @@ different display modes for classification store keys in the output definition c
 for eq. 
 ```php
     $outputDataConfig = OutputDataConfigToolkitBundle\Service::getOutputDataConfig($object, 'Output config channel');
-    $outputDataConfig[0]->classificationstore = 'Attributes';     ### classificationstore field name in object 
-    $outputDataConfig[0]->classificationstore_group = 'Product';  ### Classificationstore group name
+    $outputDataConfig[0]->setClassificationstore('Attributes');     ### classificationstore field name in object 
+    $outputDataConfig[0]->setClassificationstoreGroup('Product');  ### Classificationstore group name
+    # the old way was access the values directly
+    // $outputDataConfig[0]->classificationstore = 'Attributes';     ### classificationstore field name in object 
+    // $outputDataConfig[0]->classificationstore_group = 'Product';  ### Classificationstore group name
     $outputDataConfig[0]->getLabeledValue($object);
 ```
diff --git a/src/ConfigElement/AbstractConfigElement.php b/src/ConfigElement/AbstractConfigElement.php
@@ -22,6 +22,12 @@ abstract class AbstractConfigElement implements IConfigElement
 
     protected $context;
 
+    /** @var string|null */
+    public ?string $classificationstore = null;
+
+    /** @var string|null */
+    public ?string $classificationstore_group = null;
+
     public function __construct($config, $context = null)
     {
         $this->attribute = $config->attribute ?? null;
@@ -35,6 +41,26 @@ public function getLabel()
         return $this->label;
     }
 
+    public function getClassificationstore(): ?string
+    {
+        return $this->classificationstore;
+    }
+
+    public function getClassificationstoreGroup(): ?string
+    {
+        return $this->classificationstore_group;
+    }
+
+    public function setClassificationstore(?string $classificationstore): void
+    {
+        $this->classificationstore = $classificationstore;
+    }
+
+    public function setClassificationstoreGroup(?string $classificationstore_group): void
+    {
+        $this->classificationstore_group = $classificationstore_group;
+    }
+
     public function getAttribute()
     {
         return $this->attribute;

diff --git a/src/ConfigElement/Operator/Concatenator.php b/src/ConfigElement/Operator/Concatenator.php
@@ -15,6 +15,8 @@
 
 namespace OutputDataConfigToolkitBundle\ConfigElement\Operator;
 
+use OutputDataConfigToolkitBundle\ConfigElement\AbstractConfigElement;
+
 class Concatenator extends AbstractOperator
 {
     protected $glue;
@@ -44,6 +46,11 @@ public function getLabeledValue($object)
         $valueArray = [];
 
         foreach ($childs as $c) {
+            if ($c instanceof AbstractConfigElement) {
+                $c->setClassificationstore($this->getClassificationstore());
+                $c->setClassificationstoreGroup($this->getClassificationstoreGroup());
+            }
+
             $value = $c->getLabeledValue($object) ? $c->getLabeledValue($object)->value : null;
 
             if (!$hasValue) {

diff --git a/src/ConfigElement/Operator/Group.php b/src/ConfigElement/Operator/Group.php
@@ -15,6 +15,8 @@
 
 namespace OutputDataConfigToolkitBundle\ConfigElement\Operator;
 
+use OutputDataConfigToolkitBundle\ConfigElement\AbstractConfigElement;
+
 class Group extends AbstractOperator
 {
     public function getLabeledValue($object)
@@ -23,6 +25,10 @@ public function getLabeledValue($object)
 
         $childs = $this->getChilds();
         foreach ($childs as $c) {
+            if ($c instanceof AbstractConfigElement) {
+                $c->setClassificationstore($this->getClassificationstore());
+                $c->setClassificationstoreGroup($this->getClassificationstoreGroup());
+            }
             $value = $c->getLabeledValue($object);
             if (!empty($value) && !$value->empty && (!method_exists($value, 'isEmpty') || !$value->isEmpty())) {
                 $valueArray[] = $value;

diff --git a/src/ConfigElement/Operator/Table.php b/src/ConfigElement/Operator/Table.php
@@ -15,6 +15,8 @@
 
 namespace OutputDataConfigToolkitBundle\ConfigElement\Operator;
 
+use OutputDataConfigToolkitBundle\ConfigElement\AbstractConfigElement;
+
 class Table extends AbstractOperator
 {
     protected $tooltip;
@@ -37,6 +39,10 @@ public function getLabeledValue($object)
         $isEmpty = false;
         $valueArray = [];
         foreach ($childs as $c) {
+            if ($c instanceof AbstractConfigElement) {
+                $c->setClassificationstore($this->getClassificationstore());
+                $c->setClassificationstoreGroup($this->getClassificationstoreGroup());
+            }
             $row = $c->getLabeledValue($object);
             $valueArray[] = $row;
             $isEmpty = $row->empty;

diff --git a/src/ConfigElement/Operator/TableCol.php b/src/ConfigElement/Operator/TableCol.php
@@ -15,6 +15,8 @@
 
 namespace OutputDataConfigToolkitBundle\ConfigElement\Operator;
 
+use OutputDataConfigToolkitBundle\ConfigElement\AbstractConfigElement;
+
 class TableCol extends AbstractOperator
 {
     protected $colspan;
@@ -34,7 +36,12 @@ public function getLabeledValue($object)
 
         $childs = $this->getChilds();
         if ($childs) {
-            $value = $childs[0]->getLabeledValue($object);
+            $c = $childs[0];
+            if ($c instanceof AbstractConfigElement) {
+                $c->setClassificationstore($this->getClassificationstore());
+                $c->setClassificationstoreGroup($this->getClassificationstoreGroup());
+            }
+            $value = $c->getLabeledValue($object);
             $value->colSpan = $this->colspan;
             $value->headline = $this->headline;
 

diff --git a/src/ConfigElement/Operator/TableRow.php b/src/ConfigElement/Operator/TableRow.php
@@ -15,6 +15,8 @@
 
 namespace OutputDataConfigToolkitBundle\ConfigElement\Operator;
 
+use OutputDataConfigToolkitBundle\ConfigElement\AbstractConfigElement;
+
 class TableRow extends AbstractOperator
 {
     protected $headline;
@@ -35,6 +37,10 @@ public function getLabeledValue($object)
         $valueArray = [];
 
         foreach ($childs as $c) {
+            if ($c instanceof AbstractConfigElement) {
+                $c->setClassificationstore($this->getClassificationstore());
+                $c->setClassificationstoreGroup($this->getClassificationstoreGroup());
+            }
             $col = $c->getLabeledValue($object);
             if (!empty($col) && (!$col->empty && !($c instanceof \OutputDataConfigToolkitBundle\ConfigElement\Operator\Text))) {
                 $isEmpty = false;

diff --git a/src/ConfigElement/Operator/TextAddon.php b/src/ConfigElement/Operator/TextAddon.php
@@ -15,6 +15,8 @@
 
 namespace OutputDataConfigToolkitBundle\ConfigElement\Operator;
 
+use OutputDataConfigToolkitBundle\ConfigElement\AbstractConfigElement;
+
 class TextAddon extends AbstractOperator
 {
     private $addon;
@@ -30,7 +32,12 @@ public function getLabeledValue($object)
     {
         $childs = $this->getChilds();
         if (!empty($childs)) {
-            $value = $childs[0]->getLabeledValue($object);
+            $c = $childs[0];
+            if ($c instanceof AbstractConfigElement) {
+                $c->setClassificationstore($this->getClassificationstore());
+                $c->setClassificationstoreGroup($this->getClassificationstoreGroup());
+            }
+            $value = $c->getLabeledValue($object);
 
             if (!is_null($value->value)) {
                 $value->value = $value->value.$this->getAddon();

diff --git a/src/ConfigElement/Operator/TranslateValue.php b/src/ConfigElement/Operator/TranslateValue.php
@@ -15,6 +15,8 @@
 
 namespace OutputDataConfigToolkitBundle\ConfigElement\Operator;
 
+use OutputDataConfigToolkitBundle\ConfigElement\AbstractConfigElement;
+
 class TranslateValue extends AbstractOperator
 {
     private $prefix;
@@ -31,8 +33,12 @@ public function getLabeledValue($object)
         $childs = $this->getChilds();
         if ($childs) {
             $translator = \Pimcore::getContainer()->get('translator');
-
-            $value = $childs[0]->getLabeledValue($object);
+            $c = $childs[0];
+            if ($c instanceof AbstractConfigElement) {
+                $c->setClassificationstore($this->getClassificationstore());
+                $c->setClassificationstoreGroup($this->getClassificationstoreGroup());
+            }
+            $value = $c->getLabeledValue($object);
             if ($value->value) {
                 $value->value = $translator->trans($this->prefix . $value->value);
             }

diff --git a/src/ConfigElement/Value/DefaultValue.php b/src/ConfigElement/Value/DefaultValue.php
@@ -29,12 +29,6 @@ class DefaultValue extends AbstractConfigElement
     /** @var string|null */
     protected $icon;
 
-    /** @var string|null */
-    public $classificationstore;
-
-    /** @var string|null */
-    public $classificationstore_group;
-
     public function __construct($config, $context = null)
     {
         parent::__construct($config, $context);
@@ -157,15 +151,15 @@ public function getLabeledValue($object)
     protected function getLabeledValueForClassificationStore($object): ?object
     {
         // checking classification store fieldname
-        if (!$this->classificationstore) {
+        if (!$this->getClassificationstore()) {
             return null;
         }
-        $getter = 'get' . ucfirst($this->classificationstore);
+        $getter = 'get' . ucfirst($this->getClassificationstore());
         // checking classification sote group
-        if (!$this->classificationstore_group) {
+        if (!$this->getClassificationstoreGroup()) {
             return null;
         }
-        $groupDef = Classificationstore\GroupConfig::getByName($this->classificationstore_group);
+        $groupDef = Classificationstore\GroupConfig::getByName($this->getClassificationstoreGroup());
 
         // classification store
         $attribute = str_replace('#cs#', '', $this->attribute);