Reverted renaming, updated docblocks

OpenMage · Aug 26, 2024 · 12097cc · 12097cc
1 parent c7273a3
commit 12097cc
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 10 deletions.
diff --git a/app/code/core/Mage/Core/Block/Abstract.php b/app/code/core/Mage/Core/Block/Abstract.php
@@ -1198,30 +1198,34 @@ public function escapeHtml($data, $allowedTags = null)
     }
 
     /**
-     * Escape html entities
+     * Wrapper for escapeHtml() function with keeping original value
      *
      * @param string $data
      * @param string[]|null $allowedTags
      * @return Mage_Core_Model_Security_HtmlEscapedString
+     *
+     * @see Mage_Core_Model_Security_HtmlEscapedString::getUnescapedValue()
      */
-    public function getCoreModelSecurityHtmlEscapedString(string $data, ?array $allowedTags = null): Mage_Core_Model_Security_HtmlEscapedString
+    public function escapeHtmlAsObject(string $data, ?array $allowedTags = null): Mage_Core_Model_Security_HtmlEscapedString
     {
         // phpcs:ignore Ecg.Classes.ObjectInstantiation.DirectInstantiation
         return new Mage_Core_Model_Security_HtmlEscapedString($data, $allowedTags);
     }
 
     /**
-     * Escape html entities
+     * Wrapper for escapeHtml() function with keeping original value
      *
      * @param string[] $data
      * @param string[]|null $allowedTags
      * @return Mage_Core_Model_Security_HtmlEscapedString[]
+     *
+     *  @see Mage_Core_Model_Security_HtmlEscapedString::getUnescapedValue()
      */
-    public function getCoreModelSecurityHtmlArrayEscapedString(array $data, ?array $allowedTags = null): array
+    public function escapeHtmlArrayAsObject(array $data, ?array $allowedTags = null): array
     {
         $result = [];
         foreach ($data as $key => $string) {
-            $result[$key] = $this->getCoreModelSecurityHtmlEscapedString($string, $allowedTags);
+            $result[$key] = $this->escapeHtmlAsObject($string, $allowedTags);
         }
 
         return $result;

diff --git a/app/code/core/Mage/Core/Model/Security/HtmlEscapedString.php b/app/code/core/Mage/Core/Model/Security/HtmlEscapedString.php
@@ -44,6 +44,8 @@ public function __construct(string $originalValue, ?array $allowedTags = null)
     }
 
     /**
+     * Get escaped html entities
+     *
      * @return string
      */
     public function __toString(): string
@@ -55,6 +57,8 @@ public function __toString(): string
     }
 
     /**
+     * Get un-escaped html entities
+     *
      * @return string
      */
     public function getUnescapedValue(): string

diff --git a/app/code/core/Mage/Page/Block/Html/Header.php b/app/code/core/Mage/Page/Block/Html/Header.php
@@ -57,7 +57,7 @@ public function setLogo($logo_src, $logo_alt)
     public function getLogoSrc()
     {
         if (empty($this->_data['logo_src'])) {
-            $this->_data['logo_src'] = $this->getCoreModelSecurityHtmlEscapedString((string) Mage::getStoreConfig('design/header/logo_src'));
+            $this->_data['logo_src'] = $this->escapeHtmlAsObject((string) Mage::getStoreConfig('design/header/logo_src'));
         }
         return $this->getSkinUrl($this->_data['logo_src']);
     }
@@ -68,7 +68,7 @@ public function getLogoSrc()
     public function getLogoSrcSmall()
     {
         if (empty($this->_data['logo_src_small'])) {
-            $this->_data['logo_src_small'] = $this->getCoreModelSecurityHtmlEscapedString((string) Mage::getStoreConfig('design/header/logo_src_small'));
+            $this->_data['logo_src_small'] = $this->escapeHtmlAsObject((string) Mage::getStoreConfig('design/header/logo_src_small'));
         }
         return $this->getSkinUrl($this->_data['logo_src_small']);
     }
@@ -79,7 +79,7 @@ public function getLogoSrcSmall()
     public function getLogoAlt()
     {
         if (empty($this->_data['logo_alt'])) {
-            $this->_data['logo_alt'] = $this->getCoreModelSecurityHtmlEscapedString((string) Mage::getStoreConfig('design/header/logo_alt'));
+            $this->_data['logo_alt'] = $this->escapeHtmlAsObject((string) Mage::getStoreConfig('design/header/logo_alt'));
         }
         return $this->_data['logo_alt'];
     }
@@ -97,7 +97,7 @@ public function getWelcome()
             if (Mage::isInstalled() && Mage::getSingleton('customer/session')->isLoggedIn()) {
                 $this->_data['welcome'] = $this->__('Welcome, %s!', $this->escapeHtml(Mage::getSingleton('customer/session')->getCustomer()->getName()));
             } else {
-                $this->_data['welcome'] = $this->getCoreModelSecurityHtmlEscapedString((string) Mage::getStoreConfig('design/header/welcome'));
+                $this->_data['welcome'] = $this->escapeHtmlAsObject((string) Mage::getStoreConfig('design/header/welcome'));
             }
         }
 

diff --git a/app/code/core/Mage/Page/Block/Html/Welcome.php b/app/code/core/Mage/Page/Block/Html/Welcome.php
@@ -44,7 +44,7 @@ protected function _toHtml()
             if (Mage::isInstalled() && $this->_getSession()->isLoggedIn()) {
                 $this->_data['welcome'] = $this->__('Welcome, %s!', $this->escapeHtml($this->_getSession()->getCustomer()->getName()));
             } else {
-                $this->_data['welcome'] = $this->getCoreModelSecurityHtmlEscapedString((string) Mage::getStoreConfig('design/header/welcome'));
+                $this->_data['welcome'] = $this->escapeHtmlAsObject((string) Mage::getStoreConfig('design/header/welcome'));
             }
         }