ENGCOM-6235: Clearer PHPDocs comment for AbstractBlock and Escaper #25478

magento-engcom-team · magento-engcom-team · commit 158174bac671 · 2020-01-06T14:08:25.000-06:00
- Merge Pull Request #25478 from edward-simpson/magento2:abstractblock-phpdocs-escapejsquote - Merged commits: 1. ab1d4d6 2. 9bbc8f2 3. 26fefb1 4. 43c659e
diff --git a/lib/internal/Magento/Framework/Escaper.php b/lib/internal/Magento/Framework/Escaper.php
@@ -310,9 +310,9 @@ public function escapeCss($string)
     }
 
     /**
-     * Escape quotes in java script
+     * Escape single quotes/apostrophes ('), or other specified $quote character in javascript
      *
-     * @param string|array $data
+     * @param string|string[]|array $data
      * @param string $quote
      * @return string|array
      * @deprecated 100.2.0
diff --git a/lib/internal/Magento/Framework/View/Element/AbstractBlock.php b/lib/internal/Magento/Framework/View/Element/AbstractBlock.php
@@ -995,10 +995,11 @@ public function escapeQuote($data, $addSlashes = false)
     }
 
     /**
-     * Escape quotes in java scripts
+     * Escape single quotes/apostrophes ('), or other specified $quote character in javascript
      *
-     * @param string|array $data
+     * @param string|string[]|array $data
      * @param string $quote
+     *
      * @return string|array
      * @deprecated 100.2.0
      */

Original file line number	Diff line number	Diff line change
`@@ -310,9 +310,9 @@ public function escapeCss($string)`
`310`	`310`	`}`
`311`	`311`
`312`	`312`	`/**`
`313`		`- * Escape quotes in java script`
	`313`	`+ * Escape single quotes/apostrophes ('), or other specified $quote character in javascript`
`314`	`314`	`*`
`315`		`- * @param string\|array $data`
	`315`	`+ * @param string\|string[]\|array $data`
`316`	`316`	`* @param string $quote`
`317`	`317`	`* @return string\|array`
`318`	`318`	`* @deprecated 100.2.0`
Original file line number	Diff line number	Diff line change
`@@ -995,10 +995,11 @@ public function escapeQuote($data, $addSlashes = false)`
`995`	`995`	`}`
`996`	`996`
`997`	`997`	`/**`
`998`		`- * Escape quotes in java scripts`
	`998`	`+ * Escape single quotes/apostrophes ('), or other specified $quote character in javascript`
`999`	`999`	`*`
`1000`		`- * @param string\|array $data`
	`1000`	`+ * @param string\|string[]\|array $data`
`1001`	`1001`	`* @param string $quote`
	`1002`	`+ *`
`1002`	`1003`	`* @return string\|array`
`1003`	`1004`	`* @deprecated 100.2.0`
`1004`	`1005`	`*/`