[CLEANUP] Avoid Hungarian notation for string*

oliverklee · oliverklee · commit be178dcb00ef · 2025-02-23T23:22:56.000+01:00
Part of #756
diff --git a/src/OutputFormat.php b/src/OutputFormat.php
@@ -13,7 +13,7 @@ class OutputFormat
      *
      * @internal since 8.8.0, will be made private in 9.0.0
      */
-    public $sStringQuotingType = '"';
+    public $stringQuotingType = '"';
 
     /**
      * Output RGB colors in hash notation if possible
@@ -305,15 +305,15 @@ public function __call(string $sMethodName, array $aArguments)
      */
     public function getStringQuotingType(): string
     {
-        return $this->sStringQuotingType;
+        return $this->stringQuotingType;
     }
 
     /**
      * @return $this fluent interface
      */
     public function setStringQuotingType(string $quotingType): self
     {
-        $this->sStringQuotingType = $quotingType;
+        $this->stringQuotingType = $quotingType;
 
         return $this;
     }
diff --git a/src/Parsing/ParserState.php b/src/Parsing/ParserState.php
@@ -233,15 +233,15 @@ public function consumeWhiteSpace(): array
     }
 
     /**
-     * @param string $sString
+     * @param string $string
      * @param bool $caseInsensitive
      */
-    public function comes($sString, $caseInsensitive = false): bool
+    public function comes($string, $caseInsensitive = false): bool
     {
-        $sPeek = $this->peek(\strlen($sString));
+        $sPeek = $this->peek(\strlen($string));
         return ($sPeek == '')
             ? false
-            : $this->streql($sPeek, $sString, $caseInsensitive);
+            : $this->streql($sPeek, $string, $caseInsensitive);
     }
 
     /**
@@ -390,16 +390,16 @@ private function inputLeft(): string
     }
 
     /**
-     * @param string $sString1
-     * @param string $sString2
+     * @param string $string1
+     * @param string $string2
      * @param bool $caseInsensitive
      */
-    public function streql($sString1, $sString2, $caseInsensitive = true): bool
+    public function streql($string1, $string2, $caseInsensitive = true): bool
     {
         if ($caseInsensitive) {
-            return $this->strtolower($sString1) === $this->strtolower($sString2);
+            return $this->strtolower($string1) === $this->strtolower($string2);
         } else {
-            return $sString1 === $sString2;
+            return $string1 === $string2;
         }
     }
 
@@ -412,14 +412,14 @@ public function backtrack($iAmount): void
     }
 
     /**
-     * @param string $sString
+     * @param string $string
      */
-    public function strlen($sString): int
+    public function strlen($string): int
     {
         if ($this->parserSettings->bMultibyteSupport) {
-            return \mb_strlen($sString, $this->charset);
+            return \mb_strlen($string, $this->charset);
         } else {
-            return \strlen($sString);
+            return \strlen($string);
         }
     }
 
@@ -445,63 +445,63 @@ private function substr($iStart, $length): string
     }
 
     /**
-     * @param string $sString
+     * @param string $string
      */
-    private function strtolower($sString): string
+    private function strtolower($string): string
     {
         if ($this->parserSettings->bMultibyteSupport) {
-            return \mb_strtolower($sString, $this->charset);
+            return \mb_strtolower($string, $this->charset);
         } else {
-            return \strtolower($sString);
+            return \strtolower($string);
         }
     }
 
     /**
-     * @param string $sString
+     * @param string $string
      *
      * @return array<int, string>
      *
      * @throws SourceException if the charset is UTF-8 and the string contains invalid byte sequences
      */
-    private function strsplit($sString)
+    private function strsplit($string)
     {
         if ($this->parserSettings->bMultibyteSupport) {
             if ($this->streql($this->charset, 'utf-8')) {
-                $result = \preg_split('//u', $sString, -1, PREG_SPLIT_NO_EMPTY);
+                $result = \preg_split('//u', $string, -1, PREG_SPLIT_NO_EMPTY);
                 if (!\is_array($result)) {
                     throw new SourceException('`preg_split` failed with error ' . \preg_last_error());
                 }
                 return $result;
             } else {
-                $length = \mb_strlen($sString, $this->charset);
+                $length = \mb_strlen($string, $this->charset);
                 $result = [];
                 for ($i = 0; $i < $length; ++$i) {
-                    $result[] = \mb_substr($sString, $i, 1, $this->charset);
+                    $result[] = \mb_substr($string, $i, 1, $this->charset);
                 }
                 return $result;
             }
         } else {
-            if ($sString === '') {
+            if ($string === '') {
                 return [];
             } else {
-                return \str_split($sString);
+                return \str_split($string);
             }
         }
     }
 
     /**
-     * @param string $sString
+     * @param string $string
      * @param string $sNeedle
      * @param int $offset
      *
      * @return int|false
      */
-    private function strpos($sString, $sNeedle, $offset)
+    private function strpos($string, $sNeedle, $offset)
     {
         if ($this->parserSettings->bMultibyteSupport) {
-            return \mb_strpos($sString, $sNeedle, $offset, $this->charset);
+            return \mb_strpos($string, $sNeedle, $offset, $this->charset);
         } else {
-            return \strpos($sString, $sNeedle, $offset);
+            return \strpos($string, $sNeedle, $offset);
         }
     }
 }
diff --git a/src/RuleSet/DeclarationBlock.php b/src/RuleSet/DeclarationBlock.php
@@ -45,18 +45,18 @@ public static function parse(ParserState $parserState, $list = null)
         $result = new DeclarationBlock($parserState->currentLine());
         try {
             $aSelectorParts = [];
-            $sStringWrapperChar = false;
+            $stringWrapperChar = false;
             do {
                 $aSelectorParts[] = $parserState->consume(1)
                     . $parserState->consumeUntil(['{', '}', '\'', '"'], false, false, $comments);
                 if (\in_array($parserState->peek(), ['\'', '"'], true) && \substr(\end($aSelectorParts), -1) != '\\') {
-                    if ($sStringWrapperChar === false) {
-                        $sStringWrapperChar = $parserState->peek();
-                    } elseif ($sStringWrapperChar == $parserState->peek()) {
-                        $sStringWrapperChar = false;
+                    if ($stringWrapperChar === false) {
+                        $stringWrapperChar = $parserState->peek();
+                    } elseif ($stringWrapperChar == $parserState->peek()) {
+                        $stringWrapperChar = false;
                     }
                 }
-            } while (!\in_array($parserState->peek(), ['{', '}'], true) || $sStringWrapperChar !== false);
+            } while (!\in_array($parserState->peek(), ['{', '}'], true) || $stringWrapperChar !== false);
             $result->setSelectors(\implode('', $aSelectorParts), $list);
             if ($parserState->comes('{')) {
                 $parserState->consume(1);
diff --git a/src/Value/CSSString.php b/src/Value/CSSString.php
@@ -20,15 +20,15 @@ class CSSString extends PrimitiveValue
     /**
      * @var string
      */
-    private $sString;
+    private $string;
 
     /**
-     * @param string $sString
+     * @param string $string
      * @param int<0, max> $lineNumber
      */
-    public function __construct($sString, $lineNumber = 0)
+    public function __construct($string, $lineNumber = 0)
     {
-        $this->sString = $sString;
+        $this->string = $string;
         parent::__construct($lineNumber);
     }
 
@@ -75,19 +75,19 @@ public static function parse(ParserState $parserState): CSSString
     }
 
     /**
-     * @param string $sString
+     * @param string $string
      */
-    public function setString($sString): void
+    public function setString($string): void
     {
-        $this->sString = $sString;
+        $this->string = $string;
     }
 
     /**
      * @return string
      */
     public function getString()
     {
-        return $this->sString;
+        return $this->string;
     }
 
     public function __toString(): string
@@ -97,8 +97,8 @@ public function __toString(): string
 
     public function render(OutputFormat $outputFormat): string
     {
-        $sString = \addslashes($this->sString);
-        $sString = \str_replace("\n", '\\A', $sString);
-        return $outputFormat->getStringQuotingType() . $sString . $outputFormat->getStringQuotingType();
+        $string = \addslashes($this->string);
+        $string = \str_replace("\n", '\\A', $string);
+        return $outputFormat->getStringQuotingType() . $string . $outputFormat->getStringQuotingType();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class OutputFormat`
`13`	`13`	`*`
`14`	`14`	`* @internal since 8.8.0, will be made private in 9.0.0`
`15`	`15`	`*/`
`16`		`- public $sStringQuotingType = '"';`
	`16`	`+ public $stringQuotingType = '"';`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* Output RGB colors in hash notation if possible`
`@@ -305,15 +305,15 @@ public function __call(string $sMethodName, array $aArguments)`
`305`	`305`	`*/`
`306`	`306`	`public function getStringQuotingType(): string`
`307`	`307`	`{`
`308`		`- return $this->sStringQuotingType;`
	`308`	`+ return $this->stringQuotingType;`
`309`	`309`	`}`
`310`	`310`
`311`	`311`	`/**`
`312`	`312`	`* @return $this fluent interface`
`313`	`313`	`*/`
`314`	`314`	`public function setStringQuotingType(string $quotingType): self`
`315`	`315`	`{`
`316`		`- $this->sStringQuotingType = $quotingType;`
	`316`	`+ $this->stringQuotingType = $quotingType;`
`317`	`317`
`318`	`318`	`return $this;`
`319`	`319`	`}`
Original file line number	Diff line number	Diff line change
`@@ -233,15 +233,15 @@ public function consumeWhiteSpace(): array`
`233`	`233`	`}`
`234`	`234`
`235`	`235`	`/**`
`236`		`- * @param string $sString`
	`236`	`+ * @param string $string`
`237`	`237`	`* @param bool $caseInsensitive`
`238`	`238`	`*/`
`239`		`- public function comes($sString, $caseInsensitive = false): bool`
	`239`	`+ public function comes($string, $caseInsensitive = false): bool`
`240`	`240`	`{`
`241`		`- $sPeek = $this->peek(\strlen($sString));`
	`241`	`+ $sPeek = $this->peek(\strlen($string));`
`242`	`242`	`return ($sPeek == '')`
`243`	`243`	`? false`
`244`		`- : $this->streql($sPeek, $sString, $caseInsensitive);`
	`244`	`+ : $this->streql($sPeek, $string, $caseInsensitive);`
`245`	`245`	`}`
`246`	`246`
`247`	`247`	`/**`
`@@ -390,16 +390,16 @@ private function inputLeft(): string`
`390`	`390`	`}`
`391`	`391`
`392`	`392`	`/**`
`393`		`- * @param string $sString1`
`394`		`- * @param string $sString2`
	`393`	`+ * @param string $string1`
	`394`	`+ * @param string $string2`
`395`	`395`	`* @param bool $caseInsensitive`
`396`	`396`	`*/`
`397`		`- public function streql($sString1, $sString2, $caseInsensitive = true): bool`
	`397`	`+ public function streql($string1, $string2, $caseInsensitive = true): bool`
`398`	`398`	`{`
`399`	`399`	`if ($caseInsensitive) {`
`400`		`- return $this->strtolower($sString1) === $this->strtolower($sString2);`
	`400`	`+ return $this->strtolower($string1) === $this->strtolower($string2);`
`401`	`401`	`} else {`
`402`		`- return $sString1 === $sString2;`
	`402`	`+ return $string1 === $string2;`
`403`	`403`	`}`
`404`	`404`	`}`
`405`	`405`
`@@ -412,14 +412,14 @@ public function backtrack($iAmount): void`
`412`	`412`	`}`
`413`	`413`
`414`	`414`	`/**`
`415`		`- * @param string $sString`
	`415`	`+ * @param string $string`
`416`	`416`	`*/`
`417`		`- public function strlen($sString): int`
	`417`	`+ public function strlen($string): int`
`418`	`418`	`{`
`419`	`419`	`if ($this->parserSettings->bMultibyteSupport) {`
`420`		`- return \mb_strlen($sString, $this->charset);`
	`420`	`+ return \mb_strlen($string, $this->charset);`
`421`	`421`	`} else {`
`422`		`- return \strlen($sString);`
	`422`	`+ return \strlen($string);`
`423`	`423`	`}`
`424`	`424`	`}`
`425`	`425`
`@@ -445,63 +445,63 @@ private function substr($iStart, $length): string`
`445`	`445`	`}`
`446`	`446`
`447`	`447`	`/**`
`448`		`- * @param string $sString`
	`448`	`+ * @param string $string`
`449`	`449`	`*/`
`450`		`- private function strtolower($sString): string`
	`450`	`+ private function strtolower($string): string`
`451`	`451`	`{`
`452`	`452`	`if ($this->parserSettings->bMultibyteSupport) {`
`453`		`- return \mb_strtolower($sString, $this->charset);`
	`453`	`+ return \mb_strtolower($string, $this->charset);`
`454`	`454`	`} else {`
`455`		`- return \strtolower($sString);`
	`455`	`+ return \strtolower($string);`
`456`	`456`	`}`
`457`	`457`	`}`
`458`	`458`
`459`	`459`	`/**`
`460`		`- * @param string $sString`
	`460`	`+ * @param string $string`
`461`	`461`	`*`
`462`	`462`	`* @return array<int, string>`
`463`	`463`	`*`
`464`	`464`	`* @throws SourceException if the charset is UTF-8 and the string contains invalid byte sequences`
`465`	`465`	`*/`
`466`		`- private function strsplit($sString)`
	`466`	`+ private function strsplit($string)`
`467`	`467`	`{`
`468`	`468`	`if ($this->parserSettings->bMultibyteSupport) {`
`469`	`469`	`if ($this->streql($this->charset, 'utf-8')) {`
`470`		`- $result = \preg_split('//u', $sString, -1, PREG_SPLIT_NO_EMPTY);`
	`470`	`+ $result = \preg_split('//u', $string, -1, PREG_SPLIT_NO_EMPTY);`
`471`	`471`	`if (!\is_array($result)) {`
`472`	`472`	throw new SourceException('`preg_split` failed with error ' . \preg_last_error());
`473`	`473`	`}`
`474`	`474`	`return $result;`
`475`	`475`	`} else {`
`476`		`- $length = \mb_strlen($sString, $this->charset);`
	`476`	`+ $length = \mb_strlen($string, $this->charset);`
`477`	`477`	`$result = [];`
`478`	`478`	`for ($i = 0; $i < $length; ++$i) {`
`479`		`- $result[] = \mb_substr($sString, $i, 1, $this->charset);`
	`479`	`+ $result[] = \mb_substr($string, $i, 1, $this->charset);`
`480`	`480`	`}`
`481`	`481`	`return $result;`
`482`	`482`	`}`
`483`	`483`	`} else {`
`484`		`- if ($sString === '') {`
	`484`	`+ if ($string === '') {`
`485`	`485`	`return [];`
`486`	`486`	`} else {`
`487`		`- return \str_split($sString);`
	`487`	`+ return \str_split($string);`
`488`	`488`	`}`
`489`	`489`	`}`
`490`	`490`	`}`
`491`	`491`
`492`	`492`	`/**`
`493`		`- * @param string $sString`
	`493`	`+ * @param string $string`
`494`	`494`	`* @param string $sNeedle`
`495`	`495`	`* @param int $offset`
`496`	`496`	`*`
`497`	`497`	`* @return int\|false`
`498`	`498`	`*/`
`499`		`- private function strpos($sString, $sNeedle, $offset)`
	`499`	`+ private function strpos($string, $sNeedle, $offset)`
`500`	`500`	`{`
`501`	`501`	`if ($this->parserSettings->bMultibyteSupport) {`
`502`		`- return \mb_strpos($sString, $sNeedle, $offset, $this->charset);`
	`502`	`+ return \mb_strpos($string, $sNeedle, $offset, $this->charset);`
`503`	`503`	`} else {`
`504`		`- return \strpos($sString, $sNeedle, $offset);`
	`504`	`+ return \strpos($string, $sNeedle, $offset);`
`505`	`505`	`}`
`506`	`506`	`}`
`507`	`507`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,15 +20,15 @@ class CSSString extends PrimitiveValue`
`20`	`20`	`/**`
`21`	`21`	`* @var string`
`22`	`22`	`*/`
`23`		`- private $sString;`
	`23`	`+ private $string;`
`24`	`24`
`25`	`25`	`/**`
`26`		`- * @param string $sString`
	`26`	`+ * @param string $string`
`27`	`27`	`* @param int<0, max> $lineNumber`
`28`	`28`	`*/`
`29`		`- public function __construct($sString, $lineNumber = 0)`
	`29`	`+ public function __construct($string, $lineNumber = 0)`
`30`	`30`	`{`
`31`		`- $this->sString = $sString;`
	`31`	`+ $this->string = $string;`
`32`	`32`	`parent::__construct($lineNumber);`
`33`	`33`	`}`
`34`	`34`
`@@ -75,19 +75,19 @@ public static function parse(ParserState $parserState): CSSString`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`/**`
`78`		`- * @param string $sString`
	`78`	`+ * @param string $string`
`79`	`79`	`*/`
`80`		`- public function setString($sString): void`
	`80`	`+ public function setString($string): void`
`81`	`81`	`{`
`82`		`- $this->sString = $sString;`
	`82`	`+ $this->string = $string;`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`/**`
`86`	`86`	`* @return string`
`87`	`87`	`*/`
`88`	`88`	`public function getString()`
`89`	`89`	`{`
`90`		`- return $this->sString;`
	`90`	`+ return $this->string;`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`public function __toString(): string`
`@@ -97,8 +97,8 @@ public function __toString(): string`
`97`	`97`
`98`	`98`	`public function render(OutputFormat $outputFormat): string`
`99`	`99`	`{`
`100`		`- $sString = \addslashes($this->sString);`
`101`		`- $sString = \str_replace("\n", '\\A', $sString);`
`102`		`- return $outputFormat->getStringQuotingType() . $sString . $outputFormat->getStringQuotingType();`
	`100`	`+ $string = \addslashes($this->string);`
	`101`	`+ $string = \str_replace("\n", '\\A', $string);`
	`102`	`+ return $outputFormat->getStringQuotingType() . $string . $outputFormat->getStringQuotingType();`
`103`	`103`	`}`
`104`	`104`	`}`