ENGCOM-3518: Framework Escaper - remove direct Object Manager usage #19310

Author: sidolov

lib/internal/Magento/Framework/Escaper.php

@@ -46,6 +46,20 @@ class Escaper
      */
     private $escapeAsUrlAttributes = ['href'];
 
+    /**
+     * @param \Magento\Framework\ZendEscaper|null $escaper
+     * @param \Psr\Log\LoggerInterface|null $logger
+     */
+    public function __construct(
+        \Magento\Framework\ZendEscaper $escaper = null,
+        \Psr\Log\LoggerInterface $logger = null
+    ) {
+        $this->escaper = $escaper ?? \Magento\Framework\App\ObjectManager::getInstance()
+                ->get(\Magento\Framework\ZendEscaper::class);
+        $this->logger = $logger ?? \Magento\Framework\App\ObjectManager::getInstance()
+                ->get(\Psr\Log\LoggerInterface::class);
+    }
+
     /**
      * Escape string for HTML context.
      *
@@ -84,7 +98,7 @@ function ($errorNumber, $errorString) {
                     );
                 } catch (\Exception $e) {
                     restore_error_handler();
-                    $this->getLogger()->critical($e);
+                    $this->logger->critical($e);
                 }
                 restore_error_handler();
 
@@ -201,7 +215,7 @@ private function escapeAttributeValue($name, $value)
     public function escapeHtmlAttr($string, $escapeSingleQuote = true)
     {
         if ($escapeSingleQuote) {
-            return $this->getEscaper()->escapeHtmlAttr((string) $string);
+            return $this->escaper->escapeHtmlAttr((string) $string);
         }
         return htmlspecialchars((string)$string, ENT_COMPAT, 'UTF-8', false);
     }
@@ -226,7 +240,7 @@ public function escapeUrl($string)
      */
     public function encodeUrlParam($string)
     {
-        return $this->getEscaper()->escapeUrl($string);
+        return $this->escaper->escapeUrl($string);
     }
 
     /**
@@ -265,7 +279,7 @@ function ($matches) {
      */
     public function escapeCss($string)
     {
-        return $this->getEscaper()->escapeCss($string);
+        return $this->escaper->escapeCss($string);
     }
 
     /**
@@ -340,36 +354,6 @@ public function escapeQuote($data, $addSlashes = false)
         return htmlspecialchars($data, ENT_QUOTES, null, false);
     }
 
-    /**
-     * Get escaper
-     *
-     * @return \Magento\Framework\ZendEscaper
-     * @deprecated 100.2.0
-     */
-    private function getEscaper()
-    {
-        if ($this->escaper == null) {
-            $this->escaper = \Magento\Framework\App\ObjectManager::getInstance()
-                ->get(\Magento\Framework\ZendEscaper::class);
-        }
-        return $this->escaper;
-    }
-
-    /**
-     * Get logger
-     *
-     * @return \Psr\Log\LoggerInterface
-     * @deprecated 100.2.0
-     */
-    private function getLogger()
-    {
-        if ($this->logger == null) {
-            $this->logger = \Magento\Framework\App\ObjectManager::getInstance()
-                ->get(\Psr\Log\LoggerInterface::class);
-        }
-        return $this->logger;
-    }
-
     /**
      * Filter prohibited tags.
      *
@@ -384,7 +368,7 @@ private function filterProhibitedTags(array $allowedTags): array
         );
 
         if (!empty($notAllowedTags)) {
-            $this->getLogger()->critical(
+            $this->logger->critical(
                 'The following tag(s) are not allowed: ' . implode(', ', $notAllowedTags)
             );
             $allowedTags = array_diff($allowedTags, $this->notAllowedTags);

lib/internal/Magento/Framework/Filter/Test/Unit/StripTagsTest.php

@@ -12,7 +12,8 @@ class StripTagsTest extends \PHPUnit\Framework\TestCase
      */
     public function testStripTags()
     {
-        $stripTags = new \Magento\Framework\Filter\StripTags(new \Magento\Framework\Escaper());
+        $escaper = $this->createMock(\Magento\Framework\Escaper::class);
+        $stripTags = new \Magento\Framework\Filter\StripTags($escaper);
         $this->assertEquals('three', $stripTags->filter('<two>three</two>'));
     }
 }

lib/internal/Magento/Framework/Test/Unit/EscaperTest.php

@@ -30,12 +30,9 @@ class EscaperTest extends \PHPUnit\Framework\TestCase
 
     protected function setUp()
     {
-        $this->escaper = new Escaper();
         $this->zendEscaper = new \Magento\Framework\ZendEscaper();
         $this->loggerMock = $this->getMockForAbstractClass(\Psr\Log\LoggerInterface::class);
-        $objectManagerHelper = new ObjectManager($this);
-        $objectManagerHelper->setBackwardCompatibleProperty($this->escaper, 'escaper', $this->zendEscaper);
-        $objectManagerHelper->setBackwardCompatibleProperty($this->escaper, 'logger', $this->loggerMock);
+        $this->escaper = new Escaper($this->zendEscaper, $this->loggerMock);
     }
 
     /**

lib/internal/Magento/Framework/Test/Unit/UrlTest.php

@@ -141,7 +141,7 @@ protected function getUrlModel($arguments = [])
         $modelProperty->setValue($model, $this->urlModifier);
 
         $zendEscaper = new \Magento\Framework\ZendEscaper();
-        $escaper = new \Magento\Framework\Escaper();
+        $escaper = $objectManager->getObject(\Magento\Framework\Escaper::class);
         $objectManager->setBackwardCompatibleProperty($escaper, 'escaper', $zendEscaper);
         $objectManager->setBackwardCompatibleProperty($model, 'escaper', $escaper);