Merge branch 'main' into cleanup/hungarian/include-end

Author: JakeQZ

src/OutputFormat.php

@@ -163,7 +163,7 @@ class OutputFormat
      *
      * @var bool
      */
-    private $bRenderComments = false;
+    private $shouldRenderComments = false;
 
     /**
      * @var OutputFormatter|null
@@ -178,25 +178,25 @@ class OutputFormat
     /**
      * @var int
      */
-    private $iIndentationLevel = 0;
+    private $indendationLevel = 0;
 
     public function __construct() {}
 
     /**
-     * @param non-empty-string $sMethodName
+     * @param non-empty-string $methodName
      * @param array<array-key, mixed> $arguments
      *
      * @return mixed
      *
      * @throws \Exception
      */
-    public function __call(string $sMethodName, array $arguments)
+    public function __call(string $methodName, array $arguments)
     {
-        if (\method_exists(OutputFormatter::class, $sMethodName)) {
+        if (\method_exists(OutputFormatter::class, $methodName)) {
             // @deprecated since 8.8.0, will be removed in 9.0.0. Call the method on the formatter directly instead.
-            return \call_user_func_array([$this->getFormatter(), $sMethodName], $arguments);
+            return \call_user_func_array([$this->getFormatter(), $methodName], $arguments);
         } else {
-            throw new \Exception('Unknown OutputFormat method called: ' . $sMethodName);
+            throw new \Exception('Unknown OutputFormat method called: ' . $methodName);
         }
     }
 
@@ -643,17 +643,17 @@ public function setIgnoreExceptions(bool $ignoreExceptions): self
     /**
      * @internal
      */
-    public function getRenderComments(): bool
+    public function shouldRenderComments(): bool
     {
-        return $this->bRenderComments;
+        return $this->shouldRenderComments;
     }
 
     /**
      * @return $this fluent interface
      */
     public function setRenderComments(bool $renderComments): self
     {
-        $this->bRenderComments = $renderComments;
+        $this->shouldRenderComments = $renderComments;
 
         return $this;
     }
@@ -663,7 +663,7 @@ public function setRenderComments(bool $renderComments): self
      */
     public function getIndentationLevel(): int
     {
-        return $this->iIndentationLevel;
+        return $this->indendationLevel;
     }
 
     /**
@@ -689,7 +689,7 @@ public function nextLevel(): self
     {
         if ($this->nextLevelFormat === null) {
             $this->nextLevelFormat = clone $this;
-            $this->nextLevelFormat->iIndentationLevel++;
+            $this->nextLevelFormat->indendationLevel++;
             $this->nextLevelFormat->outputFormatter = null;
         }
         return $this->nextLevelFormat;

src/OutputFormatter.php

@@ -208,7 +208,7 @@ public function removeLastSemicolon(string $string): string
 
     public function comments(Commentable $commentable): string
     {
-        if (!$this->outputFormat->getRenderComments()) {
+        if (!$this->outputFormat->shouldRenderComments()) {
             return '';
         }
 

src/Parsing/ParserState.php

@@ -349,27 +349,27 @@ public function consumeUntil(
         array &$comments = []
     ): string {
         $stopCharacters = \is_array($stopCharacters) ? $stopCharacters : [$stopCharacters];
-        $out = '';
+        $consumedCharacters = '';
         $start = $this->currentPosition;
 
         while (!$this->isEnd()) {
-            $char = $this->consume(1);
-            if (\in_array($char, $stopCharacters, true)) {
+            $character = $this->consume(1);
+            if (\in_array($character, $stopCharacters, true)) {
                 if ($includeEnd) {
-                    $out .= $char;
+                    $consumedCharacters .= $character;
                 } elseif (!$consumeEnd) {
-                    $this->currentPosition -= $this->strlen($char);
+                    $this->currentPosition -= $this->strlen($character);
                 }
-                return $out;
+                return $consumedCharacters;
             }
-            $out .= $char;
+            $consumedCharacters .= $character;
             if ($comment = $this->consumeComment()) {
                 $comments[] = $comment;
             }
         }
 
         if (\in_array(self::EOF, $stopCharacters, true)) {
-            return $out;
+            return $consumedCharacters;
         }
 
         $this->currentPosition = $start;

tests/Unit/OutputFormatTest.php

@@ -688,9 +688,9 @@ public function setIgnoreExceptionsProvidesFluentInterface(): void
     /**
      * @test
      */
-    public function getRenderCommentsInitiallyReturnsFalse(): void
+    public function shouldRenderCommentsInitiallyReturnsFalse(): void
     {
-        self::assertFalse($this->subject->getRenderComments());
+        self::assertFalse($this->subject->shouldRenderComments());
     }
 
     /**
@@ -702,7 +702,7 @@ public function setRenderCommentsSetsRenderComments(bool $value): void
     {
         $this->subject->setRenderComments($value);
 
-        self::assertSame($value, $this->subject->getRenderComments());
+        self::assertSame($value, $this->subject->shouldRenderComments());
     }
 
     /**
@@ -1041,7 +1041,7 @@ public function createCompactReturnsInstanceWithRenderCommentsDisabled(): void
     {
         $newInstance = OutputFormat::createCompact();
 
-        self::assertFalse($newInstance->getRenderComments());
+        self::assertFalse($newInstance->shouldRenderComments());
     }
 
     /**
@@ -1170,6 +1170,6 @@ public function createPrettyReturnsInstanceWithRenderCommentsEnabled(): void
     {
         $newInstance = OutputFormat::createPretty();
 
-        self::assertTrue($newInstance->getRenderComments());
+        self::assertTrue($newInstance->shouldRenderComments());
     }
 }