From 469a42d9c3dedaf2817ba6ffec2f0945f83e63c0 Mon Sep 17 00:00:00 2001
From: Alexandre Alapetite <alexandre@alapetite.fr>
Date: Sun, 15 Sep 2024 12:00:46 +0200
Subject: Rename param specialchars to plaintext (#6809)

https://github.com/FreshRSS/FreshRSS/pull/6800#discussion_r1756435762
---
 lib/Minz/Request.php | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

(limited to 'lib/Minz')

diff --git a/lib/Minz/Request.php b/lib/Minz/Request.php
index 542741d4a..13a4f6841 100644
--- a/lib/Minz/Request.php
+++ b/lib/Minz/Request.php
@@ -62,26 +62,26 @@ class Minz_Request {
 	}
 
 	/**
-	 * @param bool $specialchars `true` to return special characters, `false` (default) to XML-encode them
+	 * @param bool $plaintext `true` to return special characters without any escaping (unsafe), `false` (default) to XML-encode them
 	 * @return array<string|int,string|array<string,string|int|bool>>
 	 */
-	public static function paramArray(string $key, bool $specialchars = false): array {
+	public static function paramArray(string $key, bool $plaintext = false): array {
 		if (empty(self::$params[$key]) || !is_array(self::$params[$key])) {
 			return [];
 		}
-		return $specialchars ? self::$params[$key] : Minz_Helper::htmlspecialchars_utf8(self::$params[$key]);
+		return $plaintext ? self::$params[$key] : Minz_Helper::htmlspecialchars_utf8(self::$params[$key]);
 	}
 
 	/**
-	 * @param bool $specialchars `true` to return special characters, `false` (default) to XML-encode them
+	 * @param bool $plaintext `true` to return special characters without any escaping (unsafe), `false` (default) to XML-encode them
 	 * @return array<string>
 	 */
-	public static function paramArrayString(string $key, bool $specialchars = false): array {
+	public static function paramArrayString(string $key, bool $plaintext = false): array {
 		if (empty(self::$params[$key]) || !is_array(self::$params[$key])) {
 			return [];
 		}
 		$result = array_filter(self::$params[$key], 'is_string');
-		return $specialchars ? $result : Minz_Helper::htmlspecialchars_utf8($result);
+		return $plaintext ? $result : Minz_Helper::htmlspecialchars_utf8($result);
 	}
 
 	public static function paramTernary(string $key): ?bool {
@@ -113,14 +113,14 @@ class Minz_Request {
 	}
 
 	/**
-	 * @param bool $specialchars `true` to return special characters, `false` (default) to XML-encode them
+	 * @param bool $plaintext `true` to return special characters without any escaping (unsafe), `false` (default) to XML-encode them
 	 */
-	public static function paramStringNull(string $key, bool $specialchars = false): ?string {
+	public static function paramStringNull(string $key, bool $plaintext = false): ?string {
 		if (isset(self::$params[$key])) {
 			$s = self::$params[$key];
 			if (is_string($s)) {
 				$s = trim($s);
-				return $specialchars ? $s : htmlspecialchars($s, ENT_COMPAT, 'UTF-8');
+				return $plaintext ? $s : htmlspecialchars($s, ENT_COMPAT, 'UTF-8');
 			}
 			if (is_int($s) || is_bool($s)) {
 				return (string)$s;
@@ -130,10 +130,10 @@ class Minz_Request {
 	}
 
 	/**
-	 * @param bool $specialchars `true` to return special characters, `false` (default) to XML-encode them
+	 * @param bool $plaintext `true` to return special characters without any escaping (unsafe), `false` (default) to XML-encode them
 	 */
-	public static function paramString(string $key, bool $specialchars = false): string {
-		return self::paramStringNull($key, $specialchars) ?? '';
+	public static function paramString(string $key, bool $plaintext = false): string {
+		return self::paramStringNull($key, $plaintext) ?? '';
 	}
 
 	/**
-- 
cgit v1.2.3