[CLEANUP] Avoid Hungarian notion for the Commentable interface (#804)

oliverklee · web-flow · commit 24f44c2ad2aa · 2025-01-25T19:25:21.000Z
Also adapt the implementing classes accordingly. Part of #756.
diff --git a/src/CSSList/CSSList.php b/src/CSSList/CSSList.php
@@ -36,7 +36,7 @@ abstract class CSSList implements Renderable, Commentable
     /**
      * @var array<array-key, Comment>
      */
-    protected $aComments;
+    protected $comments;
 
     /**
      * @var array<int, RuleSet|CSSList|Import|Charset>
@@ -53,7 +53,7 @@ abstract class CSSList implements Renderable, Commentable
      */
     public function __construct($iLineNo = 0)
     {
-        $this->aComments = [];
+        $this->comments = [];
         $this->aContents = [];
         $this->iLineNo = $iLineNo;
     }
@@ -456,26 +456,26 @@ public function getContents()
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      */
-    public function addComments(array $aComments): void
+    public function addComments(array $comments): void
     {
-        $this->aComments = \array_merge($this->aComments, $aComments);
+        $this->comments = \array_merge($this->comments, $comments);
     }
 
     /**
      * @return array<array-key, Comment>
      */
     public function getComments()
     {
-        return $this->aComments;
+        return $this->comments;
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      */
-    public function setComments(array $aComments): void
+    public function setComments(array $comments): void
     {
-        $this->aComments = $aComments;
+        $this->comments = $comments;
     }
 }
diff --git a/src/Comment/Commentable.php b/src/Comment/Commentable.php
@@ -7,21 +7,21 @@
 interface Commentable
 {
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      *
      * @return void
      */
-    public function addComments(array $aComments);
+    public function addComments(array $comments);
 
     /**
      * @return array<array-key, Comment>
      */
     public function getComments();
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      *
      * @return void
      */
-    public function setComments(array $aComments);
+    public function setComments(array $comments);
 }
diff --git a/src/Property/CSSNamespace.php b/src/Property/CSSNamespace.php
@@ -30,7 +30,7 @@ class CSSNamespace implements AtRule
     /**
      * @var array<array-key, Comment>
      */
-    protected $aComments;
+    protected $comments;
 
     /**
      * @param string $mUrl
@@ -42,7 +42,7 @@ public function __construct($mUrl, $sPrefix = null, $iLineNo = 0)
         $this->mUrl = $mUrl;
         $this->sPrefix = $sPrefix;
         $this->iLineNo = $iLineNo;
-        $this->aComments = [];
+        $this->comments = [];
     }
 
     /**
@@ -117,26 +117,26 @@ public function atRuleArgs(): array
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      */
-    public function addComments(array $aComments): void
+    public function addComments(array $comments): void
     {
-        $this->aComments = \array_merge($this->aComments, $aComments);
+        $this->comments = \array_merge($this->comments, $comments);
     }
 
     /**
      * @return array<array-key, Comment>
      */
     public function getComments()
     {
-        return $this->aComments;
+        return $this->comments;
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      */
-    public function setComments(array $aComments): void
+    public function setComments(array $comments): void
     {
-        $this->aComments = $aComments;
+        $this->comments = $comments;
     }
 }
diff --git a/src/Property/Charset.php b/src/Property/Charset.php
@@ -31,7 +31,7 @@ class Charset implements AtRule
     /**
      * @var array<array-key, Comment>
      */
-    protected $aComments;
+    protected $comments;
 
     /**
      * @param CSSString $oCharset
@@ -41,7 +41,7 @@ public function __construct(CSSString $oCharset, $iLineNo = 0)
     {
         $this->oCharset = $oCharset;
         $this->iLineNo = $iLineNo;
-        $this->aComments = [];
+        $this->comments = [];
     }
 
     /**
@@ -95,30 +95,30 @@ public function atRuleArgs()
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      *
      * @return void
      */
-    public function addComments(array $aComments): void
+    public function addComments(array $comments): void
     {
-        $this->aComments = \array_merge($this->aComments, $aComments);
+        $this->comments = \array_merge($this->comments, $comments);
     }
 
     /**
      * @return array<array-key, Comment>
      */
     public function getComments()
     {
-        return $this->aComments;
+        return $this->comments;
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      *
      * @return void
      */
-    public function setComments(array $aComments): void
+    public function setComments(array $comments): void
     {
-        $this->aComments = $aComments;
+        $this->comments = $comments;
     }
 }
diff --git a/src/Property/Import.php b/src/Property/Import.php
@@ -31,7 +31,7 @@ class Import implements AtRule
     /**
      * @var array<array-key, Comment>
      */
-    protected $aComments;
+    protected $comments;
 
     /**
      * @param URL $oLocation
@@ -43,7 +43,7 @@ public function __construct(URL $oLocation, $sMediaQuery, $iLineNo = 0)
         $this->oLocation = $oLocation;
         $this->sMediaQuery = $sMediaQuery;
         $this->iLineNo = $iLineNo;
-        $this->aComments = [];
+        $this->comments = [];
     }
 
     /**
@@ -99,27 +99,27 @@ public function atRuleArgs(): array
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      */
-    public function addComments(array $aComments): void
+    public function addComments(array $comments): void
     {
-        $this->aComments = \array_merge($this->aComments, $aComments);
+        $this->comments = \array_merge($this->comments, $comments);
     }
 
     /**
      * @return array<array-key, Comment>
      */
     public function getComments()
     {
-        return $this->aComments;
+        return $this->comments;
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      */
-    public function setComments(array $aComments): void
+    public function setComments(array $comments): void
     {
-        $this->aComments = $aComments;
+        $this->comments = $comments;
     }
 
     /**
diff --git a/src/Rule/Rule.php b/src/Rule/Rule.php
@@ -54,7 +54,7 @@ class Rule implements Renderable, Commentable
     /**
      * @var array<array-key, Comment>
      */
-    protected $aComments;
+    protected $comments;
 
     /**
      * @param string $sRule
@@ -69,7 +69,7 @@ public function __construct($sRule, $iLineNo = 0, $iColNo = 0)
         $this->aIeHack = [];
         $this->iLineNo = $iLineNo;
         $this->iColNo = $iColNo;
-        $this->aComments = [];
+        $this->comments = [];
     }
 
     /**
@@ -284,26 +284,26 @@ public function render(OutputFormat $oOutputFormat): string
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      */
-    public function addComments(array $aComments): void
+    public function addComments(array $comments): void
     {
-        $this->aComments = \array_merge($this->aComments, $aComments);
+        $this->comments = \array_merge($this->comments, $comments);
     }
 
     /**
      * @return array<array-key, Comment>
      */
     public function getComments()
     {
-        return $this->aComments;
+        return $this->comments;
     }
 
     /**
-     * @param array<array-key, Comment> $aComments
+     * @param array<array-key, Comment> $comments
      */
-    public function setComments(array $aComments): void
+    public function setComments(array $comments): void
     {
-        $this->aComments = $aComments;
+        $this->comments = $comments;
     }
 }
diff --git a/src/RuleSet/RuleSet.php b/src/RuleSet/RuleSet.php
@@ -37,7 +37,7 @@ abstract class RuleSet implements Renderable, Commentable
     /**
      * @var array<array-key, Comment>
      */
-    protected $aComments;
+    protected $comments;
 
     /**
      * @param int $iLineNo
@@ -46,7 +46,7 @@ public function __construct($iLineNo = 0)
     {
         $this->aRules = [];
         $this->iLineNo = $iLineNo;
-        $this->aComments = [];
+        $this->comments = [];
     }
 
     /**
@@ -294,26 +294,26 @@ protected function renderRules(OutputFormat $oOutputFormat)
     }
 
     /**
-     * @param array<string, Comment> $aComments
+     * @param array<string, Comment> $comments
      */
-    public function addComments(array $aComments): void
+    public function addComments(array $comments): void
     {
-        $this->aComments = \array_merge($this->aComments, $aComments);
+        $this->comments = \array_merge($this->comments, $comments);
     }
 
     /**
      * @return array<string, Comment>
      */
     public function getComments()
     {
-        return $this->aComments;
+        return $this->comments;
     }
 
     /**
-     * @param array<string, Comment> $aComments
+     * @param array<string, Comment> $comments
      */
-    public function setComments(array $aComments): void
+    public function setComments(array $comments): void
     {
-        $this->aComments = $aComments;
+        $this->comments = $comments;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ abstract class CSSList implements Renderable, Commentable`
`36`	`36`	`/**`
`37`	`37`	`* @var array<array-key, Comment>`
`38`	`38`	`*/`
`39`		`- protected $aComments;`
	`39`	`+ protected $comments;`
`40`	`40`
`41`	`41`	`/**`
`42`	`42`	`* @var array<int, RuleSet\|CSSList\|Import\|Charset>`
`@@ -53,7 +53,7 @@ abstract class CSSList implements Renderable, Commentable`
`53`	`53`	`*/`
`54`	`54`	`public function __construct($iLineNo = 0)`
`55`	`55`	`{`
`56`		`- $this->aComments = [];`
	`56`	`+ $this->comments = [];`
`57`	`57`	`$this->aContents = [];`
`58`	`58`	`$this->iLineNo = $iLineNo;`
`59`	`59`	`}`
`@@ -456,26 +456,26 @@ public function getContents()`
`456`	`456`	`}`
`457`	`457`
`458`	`458`	`/**`
`459`		`- * @param array<array-key, Comment> $aComments`
	`459`	`+ * @param array<array-key, Comment> $comments`
`460`	`460`	`*/`
`461`		`- public function addComments(array $aComments): void`
	`461`	`+ public function addComments(array $comments): void`
`462`	`462`	`{`
`463`		`- $this->aComments = \array_merge($this->aComments, $aComments);`
	`463`	`+ $this->comments = \array_merge($this->comments, $comments);`
`464`	`464`	`}`
`465`	`465`
`466`	`466`	`/**`
`467`	`467`	`* @return array<array-key, Comment>`
`468`	`468`	`*/`
`469`	`469`	`public function getComments()`
`470`	`470`	`{`
`471`		`- return $this->aComments;`
	`471`	`+ return $this->comments;`
`472`	`472`	`}`
`473`	`473`
`474`	`474`	`/**`
`475`		`- * @param array<array-key, Comment> $aComments`
	`475`	`+ * @param array<array-key, Comment> $comments`
`476`	`476`	`*/`
`477`		`- public function setComments(array $aComments): void`
	`477`	`+ public function setComments(array $comments): void`
`478`	`478`	`{`
`479`		`- $this->aComments = $aComments;`
	`479`	`+ $this->comments = $comments;`
`480`	`480`	`}`
`481`	`481`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,21 +7,21 @@`
`7`	`7`	`interface Commentable`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`		`- * @param array<array-key, Comment> $aComments`
	`10`	`+ * @param array<array-key, Comment> $comments`
`11`	`11`	`*`
`12`	`12`	`* @return void`
`13`	`13`	`*/`
`14`		`- public function addComments(array $aComments);`
	`14`	`+ public function addComments(array $comments);`
`15`	`15`
`16`	`16`	`/**`
`17`	`17`	`* @return array<array-key, Comment>`
`18`	`18`	`*/`
`19`	`19`	`public function getComments();`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * @param array<array-key, Comment> $aComments`
	`22`	`+ * @param array<array-key, Comment> $comments`
`23`	`23`	`*`
`24`	`24`	`* @return void`
`25`	`25`	`*/`
`26`		`- public function setComments(array $aComments);`
	`26`	`+ public function setComments(array $comments);`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class CSSNamespace implements AtRule`
`30`	`30`	`/**`
`31`	`31`	`* @var array<array-key, Comment>`
`32`	`32`	`*/`
`33`		`- protected $aComments;`
	`33`	`+ protected $comments;`
`34`	`34`
`35`	`35`	`/**`
`36`	`36`	`* @param string $mUrl`
`@@ -42,7 +42,7 @@ public function __construct($mUrl, $sPrefix = null, $iLineNo = 0)`
`42`	`42`	`$this->mUrl = $mUrl;`
`43`	`43`	`$this->sPrefix = $sPrefix;`
`44`	`44`	`$this->iLineNo = $iLineNo;`
`45`		`- $this->aComments = [];`
	`45`	`+ $this->comments = [];`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`/**`
`@@ -117,26 +117,26 @@ public function atRuleArgs(): array`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`/**`
`120`		`- * @param array<array-key, Comment> $aComments`
	`120`	`+ * @param array<array-key, Comment> $comments`
`121`	`121`	`*/`
`122`		`- public function addComments(array $aComments): void`
	`122`	`+ public function addComments(array $comments): void`
`123`	`123`	`{`
`124`		`- $this->aComments = \array_merge($this->aComments, $aComments);`
	`124`	`+ $this->comments = \array_merge($this->comments, $comments);`
`125`	`125`	`}`
`126`	`126`
`127`	`127`	`/**`
`128`	`128`	`* @return array<array-key, Comment>`
`129`	`129`	`*/`
`130`	`130`	`public function getComments()`
`131`	`131`	`{`
`132`		`- return $this->aComments;`
	`132`	`+ return $this->comments;`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`/**`
`136`		`- * @param array<array-key, Comment> $aComments`
	`136`	`+ * @param array<array-key, Comment> $comments`
`137`	`137`	`*/`
`138`		`- public function setComments(array $aComments): void`
	`138`	`+ public function setComments(array $comments): void`
`139`	`139`	`{`
`140`		`- $this->aComments = $aComments;`
	`140`	`+ $this->comments = $comments;`
`141`	`141`	`}`
`142`	`142`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class Charset implements AtRule`
`31`	`31`	`/**`
`32`	`32`	`* @var array<array-key, Comment>`
`33`	`33`	`*/`
`34`		`- protected $aComments;`
	`34`	`+ protected $comments;`
`35`	`35`
`36`	`36`	`/**`
`37`	`37`	`* @param CSSString $oCharset`
`@@ -41,7 +41,7 @@ public function __construct(CSSString $oCharset, $iLineNo = 0)`
`41`	`41`	`{`
`42`	`42`	`$this->oCharset = $oCharset;`
`43`	`43`	`$this->iLineNo = $iLineNo;`
`44`		`- $this->aComments = [];`
	`44`	`+ $this->comments = [];`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`/**`
`@@ -95,30 +95,30 @@ public function atRuleArgs()`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/**`
`98`		`- * @param array<array-key, Comment> $aComments`
	`98`	`+ * @param array<array-key, Comment> $comments`
`99`	`99`	`*`
`100`	`100`	`* @return void`
`101`	`101`	`*/`
`102`		`- public function addComments(array $aComments): void`
	`102`	`+ public function addComments(array $comments): void`
`103`	`103`	`{`
`104`		`- $this->aComments = \array_merge($this->aComments, $aComments);`
	`104`	`+ $this->comments = \array_merge($this->comments, $comments);`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`/**`
`108`	`108`	`* @return array<array-key, Comment>`
`109`	`109`	`*/`
`110`	`110`	`public function getComments()`
`111`	`111`	`{`
`112`		`- return $this->aComments;`
	`112`	`+ return $this->comments;`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`/**`
`116`		`- * @param array<array-key, Comment> $aComments`
	`116`	`+ * @param array<array-key, Comment> $comments`
`117`	`117`	`*`
`118`	`118`	`* @return void`
`119`	`119`	`*/`
`120`		`- public function setComments(array $aComments): void`
	`120`	`+ public function setComments(array $comments): void`
`121`	`121`	`{`
`122`		`- $this->aComments = $aComments;`
	`122`	`+ $this->comments = $comments;`
`123`	`123`	`}`
`124`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ class Rule implements Renderable, Commentable`
`54`	`54`	`/**`
`55`	`55`	`* @var array<array-key, Comment>`
`56`	`56`	`*/`
`57`		`- protected $aComments;`
	`57`	`+ protected $comments;`
`58`	`58`
`59`	`59`	`/**`
`60`	`60`	`* @param string $sRule`
`@@ -69,7 +69,7 @@ public function __construct($sRule, $iLineNo = 0, $iColNo = 0)`
`69`	`69`	`$this->aIeHack = [];`
`70`	`70`	`$this->iLineNo = $iLineNo;`
`71`	`71`	`$this->iColNo = $iColNo;`
`72`		`- $this->aComments = [];`
	`72`	`+ $this->comments = [];`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`/**`
`@@ -284,26 +284,26 @@ public function render(OutputFormat $oOutputFormat): string`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`/**`
`287`		`- * @param array<array-key, Comment> $aComments`
	`287`	`+ * @param array<array-key, Comment> $comments`
`288`	`288`	`*/`
`289`		`- public function addComments(array $aComments): void`
	`289`	`+ public function addComments(array $comments): void`
`290`	`290`	`{`
`291`		`- $this->aComments = \array_merge($this->aComments, $aComments);`
	`291`	`+ $this->comments = \array_merge($this->comments, $comments);`
`292`	`292`	`}`
`293`	`293`
`294`	`294`	`/**`
`295`	`295`	`* @return array<array-key, Comment>`
`296`	`296`	`*/`
`297`	`297`	`public function getComments()`
`298`	`298`	`{`
`299`		`- return $this->aComments;`
	`299`	`+ return $this->comments;`
`300`	`300`	`}`
`301`	`301`
`302`	`302`	`/**`
`303`		`- * @param array<array-key, Comment> $aComments`
	`303`	`+ * @param array<array-key, Comment> $comments`
`304`	`304`	`*/`
`305`		`- public function setComments(array $aComments): void`
	`305`	`+ public function setComments(array $comments): void`
`306`	`306`	`{`
`307`		`- $this->aComments = $aComments;`
	`307`	`+ $this->comments = $comments;`
`308`	`308`	`}`
`309`	`309`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ abstract class RuleSet implements Renderable, Commentable`
`37`	`37`	`/**`
`38`	`38`	`* @var array<array-key, Comment>`
`39`	`39`	`*/`
`40`		`- protected $aComments;`
	`40`	`+ protected $comments;`
`41`	`41`
`42`	`42`	`/**`
`43`	`43`	`* @param int $iLineNo`
`@@ -46,7 +46,7 @@ public function __construct($iLineNo = 0)`
`46`	`46`	`{`
`47`	`47`	`$this->aRules = [];`
`48`	`48`	`$this->iLineNo = $iLineNo;`
`49`		`- $this->aComments = [];`
	`49`	`+ $this->comments = [];`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`/**`
`@@ -294,26 +294,26 @@ protected function renderRules(OutputFormat $oOutputFormat)`
`294`	`294`	`}`
`295`	`295`
`296`	`296`	`/**`
`297`		`- * @param array<string, Comment> $aComments`
	`297`	`+ * @param array<string, Comment> $comments`
`298`	`298`	`*/`
`299`		`- public function addComments(array $aComments): void`
	`299`	`+ public function addComments(array $comments): void`
`300`	`300`	`{`
`301`		`- $this->aComments = \array_merge($this->aComments, $aComments);`
	`301`	`+ $this->comments = \array_merge($this->comments, $comments);`
`302`	`302`	`}`
`303`	`303`
`304`	`304`	`/**`
`305`	`305`	`* @return array<string, Comment>`
`306`	`306`	`*/`
`307`	`307`	`public function getComments()`
`308`	`308`	`{`
`309`		`- return $this->aComments;`
	`309`	`+ return $this->comments;`
`310`	`310`	`}`
`311`	`311`
`312`	`312`	`/**`
`313`		`- * @param array<string, Comment> $aComments`
	`313`	`+ * @param array<string, Comment> $comments`
`314`	`314`	`*/`
`315`		`- public function setComments(array $aComments): void`
	`315`	`+ public function setComments(array $comments): void`
`316`	`316`	`{`
`317`		`- $this->aComments = $aComments;`
	`317`	`+ $this->comments = $comments;`
`318`	`318`	`}`
`319`	`319`	`}`