Merge pull request #522 from Smartling/WP-880-nested-attributes-locking

add nested attributes locking, add before clone content written filter (WP-880)

Author: vsolovei-smartling

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "smartling/wordpress-connector",
   "license": "GPL-2.0-or-later",
-  "version": "3.8.12",
+  "version": "3.8.13",
   "description": "",
   "type": "wordpress-plugin",
   "repositories": [

inc/Smartling/Base/ExportedAPI.php

@@ -205,6 +205,12 @@ interface ExportedAPI
      */
     public const ACTION_AFTER_TRANSLATION_APPLIED = 'smartling_action_after_translation_applied';
 
+    /**
+     * @param array content
+     * @param SubmissionEntity
+     * @return array content
+     */
+    public const FILTER_BEFORE_CLONE_CONTENT_WRITTEN = 'smartling_filter_before_clone_content_written';
     /**
      * @param array translation
      * @param array lockedData

inc/Smartling/Base/SmartlingCore.php

@@ -88,6 +88,7 @@ public function cloneContent(SubmissionEntity $submission): void
                     $content[$key] = $this->gutenbergBlockHelper->replacePostTranslateBlockContent($value, $value, $submission);
                 }
             }
+            $content = apply_filters(ExportedAPI::FILTER_BEFORE_CLONE_CONTENT_WRITTEN, $content, $submission);
             $this->getContentHelper()->writeTargetContent($submission, $entity->fromArray($content));
 
             $metadata = [];

inc/Smartling/Helpers/ArrayHelper.php

@@ -6,6 +6,8 @@
 
 class ArrayHelper
 {
+    private const NESTED_KEY_SEPARATOR = '.';
+
     /**
      * Retrieves the value of an array element or object property with the given key or property name.
      * If the key does not exist in the array or object, the default value will be returned instead.
@@ -49,7 +51,7 @@ public static function getValue(array|object $array, string|\Closure $key, mixed
             return $array[$key];
         }
 
-        if (($pos = strrpos($key, '.')) !== false) {
+        if (($pos = strrpos($key, self::NESTED_KEY_SEPARATOR)) !== false) {
             $array = static::getValue($array, substr($key, 0, $pos), $default);
             $key = substr($key, $pos + 1);
         }
@@ -65,6 +67,23 @@ public static function getValue(array|object $array, string|\Closure $key, mixed
         return $default;
     }
 
+    public function setValue(array $array, string $key, mixed $value): array
+    {
+        $result = $array;
+        $parts = explode(self::NESTED_KEY_SEPARATOR, $key);
+        if (count($parts) > 1) {
+            $index = array_shift($parts);
+            if (!array_key_exists($index, $result)) {
+                $result[$index] = [];
+            }
+            $result[$index] = $this->setValue($result[$index], implode(self::NESTED_KEY_SEPARATOR, $parts), $value);
+        } else {
+            $result[$key] = $value;
+        }
+
+        return $result;
+    }
+
     /**
      * Removes an item from an array and returns the value. If the key does not exist in the array, the default value
      * will be returned instead.

inc/Smartling/Helpers/PostContentHelper.php

@@ -13,7 +13,7 @@ class PostContentHelper
     public const SMARTLING_LOCKED = 'smartlingLocked';
     public const SMARTLING_LOCKED_ATTRIBUTES = 'smartlingLockedAttributes';
 
-    public function __construct(private GutenbergBlockHelper $blockHelper)
+    public function __construct(private ArrayHelper $arrayHelper, private GutenbergBlockHelper $blockHelper)
     {
     }
 
@@ -38,8 +38,9 @@ public function applyContentWithBlockLocks(string $target, string $content): str
                 $targetBlock = $this->getBlockByPath($targetBlocks, $path);
                 assert($targetBlock !== null);
                 $attributes = $resultBlock->getAttributes();
-                if (array_key_exists($attribute, $targetBlock->toArray()['attrs'])) {
-                    $attributes[$attribute] = $targetBlock->getAttributes()[$attribute];
+                $targetValue = ArrayHelper::getValue($targetBlock->getAttributes(), $attribute);
+                if ($targetValue !== null) {
+                    $attributes = $this->arrayHelper->setValue($attributes, $attribute, $targetValue);
                 }
                 $resultBlocks = $this->setBlockByPath($resultBlocks, $path, $resultBlock->withAttributes($attributes));
             }

inc/config/services.yml

@@ -40,6 +40,9 @@ services:
         - "@wp.proxy"
         - "@wp.link.helper"
 
+  helper.array:
+    class: Smartling\Helpers\ArrayHelper
+
   helper.customMenu:
     class: Smartling\Helpers\CustomMenuContentTypeHelper
     arguments:
@@ -57,6 +60,7 @@ services:
   helper.post.content:
     class: Smartling\Helpers\PostContentHelper
     arguments:
+      - "@helper.array"
       - "@helper.gutenberg"
 
   helper.user:

readme.txt

@@ -4,7 +4,7 @@ Tags: translation, localization, localisation, translate, multilingual, smartlin
 Requires at least: 5.5
 Tested up to: 6.4.1
 Requires PHP: 8.0
-Stable tag: 3.8.12
+Stable tag: 3.8.13
 License: GPLv2 or later
 
 Translate content in WordPress quickly and seamlessly with Smartling, the industry-leading Translation Management System.

smartling-connector.php

@@ -11,7 +11,7 @@
  * Plugin Name:       Smartling Connector
  * Plugin URI:        https://www.smartling.com/products/automate/integrations/wordpress/
  * Description:       Integrate your WordPress site with Smartling to upload your content and download translations.
- * Version:           3.8.12
+ * Version:           3.8.13
  * Author:            Smartling
  * Author URI:        https://www.smartling.com
  * License:           GPL-2.0+

tests/Smartling/Base/SmartlingCoreTest.php

@@ -9,6 +9,7 @@
 use Smartling\Exception\SmartlingDirectRunRuntimeException;
 use Smartling\Exception\SmartlingTargetPlaceholderCreationFailedException;
 use Smartling\Extensions\Acf\AcfDynamicSupport;
+use Smartling\Helpers\ArrayHelper;
 use Smartling\Helpers\ContentSerializationHelper;
 use Smartling\Helpers\FieldsFilterHelper;
 use Smartling\Helpers\FileUriHelper;
@@ -73,7 +74,7 @@ protected function setUp(): void
             ),
             $this->createMock(FileUriHelper::class),
             $gutenbergBlockHelper,
-            new PostContentHelper($gutenbergBlockHelper),
+            new PostContentHelper(new ArrayHelper(), $gutenbergBlockHelper),
             new XmlHelper($this->createMock(ContentSerializationHelper::class), new SerializerJsonWithFallback(), $this->createMock(SettingsManager::class)),
             $this->createMock(TestRunHelper::class),
             $wpProxy,

tests/Smartling/Base/SmartlingCoreUploadTraitTest.php

@@ -8,6 +8,7 @@
 use Smartling\ContentTypes\ExternalContentManager;
 use Smartling\DbAl\WordpressContentEntities\PostEntityStd;
 use Smartling\Extensions\Acf\AcfDynamicSupport;
+use Smartling\Helpers\ArrayHelper;
 use Smartling\Helpers\ContentHelper;
 use Smartling\Helpers\ContentSerializationHelper;
 use Smartling\Helpers\DecodedXml;
@@ -328,7 +329,7 @@ public function testApplyXmlLockedBlocksById()
 
     private function assertSuccessApplyXml(SmartlingCoreUpload $smartlingCoreUpload, SubmissionEntity $submission, XmlHelper $xmlHelper)
     {
-        $postContentHelper = new PostContentHelper(new GutenbergBlockHelper(
+        $postContentHelper = new PostContentHelper(new ArrayHelper(), new GutenbergBlockHelper(
             $this->createMock(AcfDynamicSupport::class),
             $this->createMock(ContentSerializationHelper::class),
             $this->createMock(MediaAttachmentRulesManager::class),