Fix Arabic & Hebrew in invoices

Add model for processing RTL texts

Author: ihor-sviziev

app/code/Magento/Sales/Model/RtlTextHandler.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Sales\Model;
+
+use Magento\Framework\Stdlib\StringUtils;
+
+class RtlTextHandler
+{
+    /**
+     * @var StringUtils
+     */
+    private $stringUtils;
+
+    public function __construct(StringUtils $stringUtils)
+    {
+        $this->stringUtils = $stringUtils;
+    }
+
+    /**
+     * Detect an input string is Arabic
+     *
+     * @param string $subject
+     * @return bool
+     */
+    public function isRtlText(string $subject): bool
+    {
+        return (preg_match('/[\p{Arabic}\p{Hebrew}]/u', $subject) > 0);
+    }
+
+    /**
+     * Reverse text with Arabic characters
+     *
+     * @param string $string
+     * @return string
+     */
+    public function reverseArabicText(string $string): string
+    {
+        $splitText = explode(' ', $string);
+        for ($i = 0; $i < count($splitText); $i++) {
+            if ($this->isRtlText($splitText[$i])) {
+                for ($j = $i + 1; $j < count($splitText); $j++) {
+                    $tmp = ($this->isRtlText($splitText[$j]))
+                        ? $this->stringUtils->strrev($splitText[$j]) : $splitText[$j];
+                    $splitText[$j] = ($this->isRtlText($splitText[$i]))
+                        ? $this->stringUtils->strrev($splitText[$i]) : $splitText[$i];
+                    $splitText[$i] = $tmp;
+                }
+            }
+        }
+
+        return implode(' ', $splitText);
+    }
+}

app/code/Magento/Sales/Test/Unit/Model/RtlTextHandlerTest.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Magento\Sales\Test\Unit\Model;
+
+use Magento\Framework\Stdlib\StringUtils;
+use Magento\Sales\Model\RtlTextHandler;
+use PHPUnit\Framework\TestCase;
+
+class RtlTextHandlerTest extends TestCase
+{
+    /**
+     * @var RtlTextHandler
+     */
+    private $rtlTextHandler;
+
+    /**
+     * @var StringUtils
+     */
+    private $stringUtils;
+
+    protected function setUp(): void
+    {
+        $this->stringUtils = new StringUtils();
+        $this->rtlTextHandler = new RtlTextHandler($this->stringUtils);
+    }
+
+    /**
+     * @param string $str
+     * @param bool $expected
+     * @dataProvider provideRtlTexts
+     */
+    public function testIsRtlText(string $str, bool $expected): void
+    {
+        $this->assertEquals($expected, $this->rtlTextHandler->isRtlText($str));
+    }
+
+    /**
+     * @param string $str
+     * @param bool $expected
+     * @dataProvider provideRtlTexts
+     */
+    public function testReverseArabicText(string $str, bool $expected): void
+    {
+        $expectedStr = $expected ? $this->stringUtils->strrev($str) : $str;
+
+        $this->assertEquals($expectedStr, $this->rtlTextHandler->reverseArabicText($str));
+    }
+
+    public function provideRtlTexts(): array
+    {
+        return [
+            ['Adeline Jacobson', false],//English
+            ['Odell Fisher', false],//English
+            ['Панов Аркадий Львович', false],//Russian
+            ['Вероника Сергеевна Игнатьева', false],//Russian
+            ['Mehmet Arnold-Döring', false],//German
+            ['Herr Prof. Dr. Gerald Schüler B.A.', false],//German
+            ['نديم مقداد نعمان القحطاني', true],//Arabic
+            ['شهاب الفرحان', true],//Arabic
+            ['צבר קרליבך', true],//Hebrew
+            ['גורי מייזליש', true],//Hebrew
+            ['اتابک بهشتی', true],//Persian
+            ['مهداد محمدی', true],//Persian
+        ];
+    }
+}