FIX: localized fields from brick and fieldcollections can be added to index

psalm.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0"?>
 <psalm
-    totallyTyped="false"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"

src/CoreShop/Bundle/IndexBundle/Controller/IndexController.php

@@ -231,13 +231,28 @@ protected function getObjectbrickFields(array $allowedBricks, &$result): array
                 $result[$key]['childs'] = [];
 
                 foreach ($fields as $field) {
-                    $fieldConfig = $this->getFieldConfiguration($field);
-                    $fieldConfig['getter'] = 'brick';
-                    $fieldConfig['configuration'] = [
-                        'className' => $key,
-                        'key' => $field->getName(),
-                    ];
-                    $result[$key]['childs'][] = $fieldConfig;
+                    if ($field instanceof DataObject\ClassDefinition\Data\Localizedfields) {
+                        $localizedfields = $this->getLocalizedFields($field)['localizedfields'];
+
+                        foreach ($localizedfields['childs'] as &$child) {
+                            $child['getter'] = 'brick';
+                            $child['configuration'] = [
+                                'className' => $key,
+                                'key' => $field->getName(),
+                            ];
+                        }
+
+                        $result[$key]['childs'][] = $localizedfields;
+                    } else {
+                        $fieldConfig = $this->getFieldConfiguration($field);
+
+                        $fieldConfig['getter'] = 'brick';
+                        $fieldConfig['configuration'] = [
+                            'className' => $key,
+                            'key' => $field->getName(),
+                        ];
+                        $result[$key]['childs'][] = $fieldConfig;
+                    }
                 }
             }
         }
@@ -260,13 +275,26 @@ protected function getFieldcollectionFields(array $allowedCollections, &$result)
             $result[$key]['childs'] = [];
 
             foreach ($fieldDefinition as $fieldcollectionField) {
-                $fieldConfig = $this->getFieldConfiguration($fieldcollectionField);
-                $fieldConfig['getter'] = 'fieldcollection';
-                $fieldConfig['configuration'] = [
-                    'className' => $key,
-                ];
+                if ($fieldcollectionField instanceof DataObject\ClassDefinition\Data\Localizedfields) {
+                    $localizedfields = $this->getLocalizedFields($fieldcollectionField)['localizedfields'];
+
+                    foreach ($localizedfields['childs'] as &$child) {
+                        $child['getter'] = 'fieldcollection';
+                        $child['configuration'] = [
+                            'className' => $key,
+                        ];
+                    }
 
-                $result[$key]['childs'][] = $fieldConfig;
+                    $result[$key]['childs'][] = $localizedfields;
+                } else {
+                    $fieldConfig = $this->getFieldConfiguration($fieldcollectionField);
+
+                    $fieldConfig['getter'] = 'fieldcollection';
+                    $fieldConfig['configuration'] = [
+                        'className' => $key,
+                    ];
+                    $result[$key]['childs'][] = $fieldConfig;
+                }
             }
         }
 

src/CoreShop/Bundle/IndexBundle/Resources/config/services.yml

@@ -132,6 +132,8 @@ services:
 
     # Index Getter
     CoreShop\Component\Index\Getter\BrickGetter:
+        arguments:
+            - '@coreshop.translation_locale_provider'
         tags:
           - { name: coreshop.index.getter, type: brick, form-type: CoreShop\Bundle\IndexBundle\Form\Type\Getter\BrickGetterFormType}
 
@@ -140,6 +142,8 @@ services:
           - { name: coreshop.index.getter, type: classificationstore, form-type: CoreShop\Bundle\IndexBundle\Form\Type\Getter\ClassificationStoreGetterFormType}
 
     CoreShop\Component\Index\Getter\FieldCollectionGetter:
+        arguments:
+            - '@coreshop.translation_locale_provider'
         tags:
           - { name: coreshop.index.getter, type: fieldcollection, form-type: CoreShop\Bundle\IndexBundle\Form\Type\Getter\FieldCollectionGetterFormType}
 

src/CoreShop/Bundle/IndexBundle/Resources/public/pimcore/js/index/fields.js

@@ -270,7 +270,17 @@ coreshop.index.fields = Class.create({
         });
 
         tree.addListener('itemdblclick', function (tree, record, item, index, e, eOpts) {
-            if (!record.data.root && record.datatype !== 'layout' && record.data.dataType !== 'localizedfields') {
+            if (
+                !record.data.root &&
+                (
+                    record.datatype &&
+                    record.datatype !== 'layout'
+                ) ||
+                (
+                    record.data.dataType &&
+                    record.data.dataType !== 'localizedfields'
+                )
+            ) {
                 var copy = Ext.apply({}, record.data);
 
                 copy.id = Ext.id();
@@ -317,7 +327,29 @@ coreshop.index.fields = Class.create({
 
                     baseNode = tree.getRootNode().appendChild(baseNode);
                     for (var j = 0; j < data[keys[i]].childs.length; j++) {
-                        var node = this.addDataChild.call(baseNode, data[keys[i]].childs[j].fieldtype, data[keys[i]].childs[j], data[keys[i]].nodeType, data[keys[i]].className);
+                        if (
+                            (data[keys[i]].nodeType == 'objectbricks' ||
+                                data[keys[i]].nodeType == 'fieldcollections') &&
+                            data[keys[i]].childs[j].nodeLabel == 'localizedfields') {
+
+                            var text = t(data[keys[i]].childs[j].nodeLabel);
+
+                            var node = {
+                                type: 'layout',
+                                allowDrag: false,
+                                iconCls: 'pimcore_icon_' + data[keys[i]].childs[j].nodeType,
+                                text: text
+                            };
+
+                            node = tree.getRootNode().appendChild(node);
+
+                            for (var k = 0; k < data[keys[i]].childs[j].childs.length; k++) {
+                                var innerNode = this.addDataChild.call(node, data[keys[i]].childs[j].childs[k].fieldtype, data[keys[i]].childs[j].childs[k], data[keys[i]].nodeType, data[keys[i]].className);
+                                node.appendChild(innerNode);
+                            }
+                        } else {
+                            var node = this.addDataChild.call(baseNode, data[keys[i]].childs[j].fieldtype, data[keys[i]].childs[j], data[keys[i]].nodeType, data[keys[i]].className);
+                        }
 
                         baseNode.appendChild(node);
                     }

src/CoreShop/Component/Index/Getter/BrickGetter.php

@@ -16,15 +16,26 @@
 
 use CoreShop\Component\Index\Model\IndexableInterface;
 use CoreShop\Component\Index\Model\IndexColumnInterface;
+use CoreShop\Component\Pimcore\DataObject\LocaleFallbackHelper;
+use CoreShop\Component\Resource\Translation\Provider\TranslationLocaleProviderInterface;
+use Pimcore\Model\DataObject\ClassDefinition\Data\Localizedfields;
+use Pimcore\Model\DataObject\Localizedfield;
+use Pimcore\Model\DataObject\Objectbrick;
+use Pimcore\Model\DataObject\Objectbrick\Data\AbstractData;
+use Pimcore\Tool;
 
 class BrickGetter implements GetterInterface
 {
+    public function __construct(protected TranslationLocaleProviderInterface $localeProvider)
+    {
+    }
+
     public function get(IndexableInterface $object, IndexColumnInterface $config): mixed
     {
         $columnConfig = $config->getConfiguration();
         $getterConfig = $config->getGetterConfig();
 
-        if (!isset($getterConfig['brickField']) || !isset($columnConfig['className']) || !isset($columnConfig['key'])) {
+        if (!isset($getterConfig['brickField'], $columnConfig['className'], $columnConfig['key'])) {
             return null;
         }
 
@@ -37,19 +48,36 @@ public function get(IndexableInterface $object, IndexColumnInterface $config): m
         }
 
         $brickContainer = $object->$brickContainerGetter();
+
         $brickGetter = 'get' . ucfirst($columnConfig['className']);
 
-        if (!$brickContainer) {
+        if (!$brickContainer instanceof Objectbrick) {
             return null;
         }
+
         $brick = $brickContainer->$brickGetter();
 
-        if ($brick) {
-            $fieldGetter = 'get' . ucfirst($columnConfig['key']);
+        if (!$brick instanceof AbstractData) {
+            return null;
+        }
+
+        $fieldGetter = 'get' . ucfirst($columnConfig['key']);
+
+        $fd = $brick->getDefinition()->getFieldDefinition($columnConfig['key']);
 
+        if (!$fd instanceof Localizedfields) {
             return $brick->$fieldGetter();
         }
 
-        return null;
+        $getter = 'get' . ucfirst($config->getObjectKey());
+
+        return LocaleFallbackHelper::useFallbackValues(function() use ($brick, $getter) {
+            $values = [];
+            foreach ($this->localeProvider->getDefinedLocalesCodes() as $locale) {
+                $values[$locale] = $brick->$getter($locale);
+            }
+
+            return $values;
+        }, true);
     }
 }

src/CoreShop/Component/Index/Getter/FieldCollectionGetter.php

@@ -16,10 +16,17 @@
 
 use CoreShop\Component\Index\Model\IndexableInterface;
 use CoreShop\Component\Index\Model\IndexColumnInterface;
+use CoreShop\Component\Pimcore\DataObject\LocaleFallbackHelper;
+use CoreShop\Component\Resource\Translation\Provider\TranslationLocaleProviderInterface;
 use Pimcore\Model\DataObject\Fieldcollection;
+use Pimcore\Model\DataObject\Localizedfield;
 
 class FieldCollectionGetter implements GetterInterface
 {
+    public function __construct(protected TranslationLocaleProviderInterface $localeProvider)
+    {
+    }
+
     public function get(IndexableInterface $object, IndexColumnInterface $config): mixed
     {
         $columnConfig = $config->getConfiguration();
@@ -44,9 +51,30 @@ public function get(IndexableInterface $object, IndexColumnInterface $config): m
         }
 
         foreach ($validItems as $item) {
-            if (method_exists($item, $fieldGetter)) {
-                $fieldValues[] = $item->$fieldGetter();
+            $fd = $item->getDefinition()->getFieldDefinition($config->getObjectKey());
+
+            if (!$fd) {
+                continue;
+            }
+
+            if (!method_exists($item, $fieldGetter)) {
+                continue;
             }
+
+            if ($fd instanceof Localizedfield) {
+                $fieldValues[] = LocaleFallbackHelper::useFallbackValues(function() use ($item, $fieldGetter) {
+                    $values = [];
+
+                    foreach ($this->localeProvider->getDefinedLocalesCodes() as $locale) {
+                        $values[$locale] = $item->$fieldGetter($locale);
+                    }
+
+                    return $values;
+                });
+                continue;
+            }
+
+            $fieldValues[] = $item->$fieldGetter();
         }
 
         return count($fieldValues) > 0 ? $fieldValues : null;

src/CoreShop/Component/Index/Getter/LocalizedFieldGetter.php

@@ -16,8 +16,9 @@
 
 use CoreShop\Component\Index\Model\IndexableInterface;
 use CoreShop\Component\Index\Model\IndexColumnInterface;
+use CoreShop\Component\Pimcore\DataObject\InheritanceHelper;
+use CoreShop\Component\Pimcore\DataObject\LocaleFallbackHelper;
 use CoreShop\Component\Resource\Translation\Provider\TranslationLocaleProviderInterface;
-use Pimcore\Model\DataObject;
 
 class LocalizedFieldGetter implements GetterInterface
 {
@@ -29,16 +30,14 @@ public function get(IndexableInterface $object, IndexColumnInterface $config): a
     {
         $getter = 'get' . ucfirst($config->getObjectKey());
 
-        $fallbackMemory = DataObject\Localizedfield::getGetFallbackValues();
-        DataObject\Localizedfield::setGetFallbackValues(true);
+        return LocaleFallbackHelper::useFallbackValues(function() use($object, $getter) {
+            $values = [];
 
-        $values = [];
-        foreach ($this->localeProvider->getDefinedLocalesCodes() as $locale) {
-            $values[$locale] = $object->$getter($locale);
-        }
+            foreach ($this->localeProvider->getDefinedLocalesCodes() as $locale) {
+                $values[$locale] = $object->$getter($locale);
+            }
 
-        DataObject\Localizedfield::setGetFallbackValues($fallbackMemory);
-
-        return $values;
+            return $values;
+        });
     }
 }

src/CoreShop/Component/Pimcore/DataObject/LocaleFallbackHelper.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * CoreShop.
+ *
+ * This source file is subject to the GNU General Public License version 3 (GPLv3)
+ * For the full copyright and license information, please view the LICENSE.md and gpl-3.0.txt
+ * files that are distributed with this source code.
+ *
+ * @copyright  Copyright (c) CoreShop GmbH (https://www.coreshop.org)
+ * @license    https://www.coreshop.org/license     GNU General Public License version 3 (GPLv3)
+ */
+
+declare(strict_types=1);
+
+namespace CoreShop\Component\Pimcore\DataObject;
+
+use Pimcore\Model\DataObject;
+
+class LocaleFallbackHelper
+{
+    /**
+     * This function enables usage of locale fallback in Pimcore and resets the state of locale fallback automatically
+     * after your functions is finished.
+     */
+    public static function useFallbackValues(\Closure $function, bool $useFallback = true): mixed
+    {
+        $backup = DataObject\Localizedfield::getGetFallbackValues();
+        DataObject\Localizedfield::setGetFallbackValues($useFallback);
+
+        $result = $function();
+
+        DataObject\Localizedfield::setGetFallbackValues($backup);
+
+        return $result;
+    }
+}