[TASK] Use native type declarations for Renderable (#891)

oliverklee · web-flow · commit 6e432588201e · 2025-02-09T15:43:12.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,7 +24,7 @@ Please also have a look at our
 - Only allow `string` for some `OutputFormat` properties (#885)
 - Make all non-private properties `@internal` (#886)
 - Use more native type declarations and strict mode
-  (#641, #772, #774, #778, #804, #841, #873, #875)
+  (#641, #772, #774, #778, #804, #841, #873, #875, #891)
 - Add visibility to all class/interface constants (#469)
 
 ### Deprecated
diff --git a/src/CSSList/AtRuleBlockList.php b/src/CSSList/AtRuleBlockList.php
@@ -25,7 +25,7 @@ class AtRuleBlockList extends CSSBlockList implements AtRule
     /**
      * @param string $type
      * @param string $arguments
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($type, $arguments = '', $lineNumber = 0)
     {
diff --git a/src/CSSList/CSSBlockList.php b/src/CSSList/CSSBlockList.php
@@ -21,7 +21,7 @@
 abstract class CSSBlockList extends CSSList
 {
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($lineNumber = 0)
     {
diff --git a/src/CSSList/CSSList.php b/src/CSSList/CSSList.php
@@ -48,14 +48,14 @@ abstract class CSSList implements Renderable, Commentable
     protected $contents;
 
     /**
-     * @var int
+     * @var int<0, max>
      *
      * @internal since 8.8.0
      */
     protected $lineNumber;
 
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($lineNumber = 0)
     {
@@ -255,9 +255,9 @@ private static function identifierIs($identifier, string $match): bool
     }
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo()
+    public function getLineNo(): int
     {
         return $this->lineNumber;
     }
diff --git a/src/CSSList/Document.php b/src/CSSList/Document.php
@@ -19,7 +19,7 @@
 class Document extends CSSBlockList
 {
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($lineNumber = 0)
     {
diff --git a/src/CSSList/KeyFrame.php b/src/CSSList/KeyFrame.php
@@ -20,7 +20,7 @@ class KeyFrame extends CSSList implements AtRule
     private $animationName;
 
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($lineNumber = 0)
     {
diff --git a/src/Comment/Comment.php b/src/Comment/Comment.php
@@ -10,7 +10,7 @@
 class Comment implements Renderable
 {
     /**
-     * @var int
+     * @var int<0, max>
      *
      * @internal since 8.8.0
      */
@@ -25,7 +25,7 @@ class Comment implements Renderable
 
     /**
      * @param string $commentText
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($commentText = '', $lineNumber = 0)
     {
@@ -42,9 +42,9 @@ public function getComment()
     }
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo()
+    public function getLineNo(): int
     {
         return $this->lineNumber;
     }
diff --git a/src/Parser.php b/src/Parser.php
@@ -20,7 +20,7 @@ class Parser
 
     /**
      * @param string $sText the complete CSS as text (i.e., usually the contents of a CSS file)
-     * @param int $lineNumber the line number (starting from 1, not from 0)
+     * @param int<0, max> $lineNumber the line number (starting from 1, not from 0)
      */
     public function __construct($sText, ?Settings $oParserSettings = null, $lineNumber = 1)
     {
diff --git a/src/Parsing/OutputException.php b/src/Parsing/OutputException.php
@@ -11,7 +11,7 @@ final class OutputException extends SourceException
 {
     /**
      * @param string $sMessage
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($sMessage, $lineNumber = 0)
     {
diff --git a/src/Parsing/ParserState.php b/src/Parsing/ParserState.php
@@ -58,7 +58,7 @@ class ParserState
 
     /**
      * @param string $sText the complete CSS as text (i.e., usually the contents of a CSS file)
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($sText, Settings $oParserSettings, $lineNumber = 1)
     {
diff --git a/src/Parsing/SourceException.php b/src/Parsing/SourceException.php
@@ -13,7 +13,7 @@ class SourceException extends \Exception
 
     /**
      * @param string $sMessage
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($sMessage, $lineNumber = 0)
     {
@@ -25,9 +25,9 @@ public function __construct($sMessage, $lineNumber = 0)
     }
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo()
+    public function getLineNo(): int
     {
         return $this->lineNumber;
     }
diff --git a/src/Parsing/UnexpectedTokenException.php b/src/Parsing/UnexpectedTokenException.php
@@ -30,7 +30,7 @@ class UnexpectedTokenException extends SourceException
      * @param string $sExpected
      * @param string $sFound
      * @param string $sMatchType
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($sExpected, $sFound, $sMatchType = 'literal', $lineNumber = 0)
     {
diff --git a/src/Property/CSSNamespace.php b/src/Property/CSSNamespace.php
@@ -37,7 +37,7 @@ class CSSNamespace implements AtRule
     /**
      * @param string $mUrl
      * @param string|null $sPrefix
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($mUrl, $sPrefix = null, $lineNumber = 0)
     {
@@ -48,9 +48,9 @@ public function __construct($mUrl, $sPrefix = null, $lineNumber = 0)
     }
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo()
+    public function getLineNo(): int
     {
         return $this->lineNumber;
     }
diff --git a/src/Property/Charset.php b/src/Property/Charset.php
@@ -24,7 +24,7 @@ class Charset implements AtRule
     private $oCharset;
 
     /**
-     * @var int
+     * @var int<0, max>
      *
      * @internal since 8.8.0
      */
@@ -38,7 +38,7 @@ class Charset implements AtRule
     protected $comments;
 
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct(CSSString $oCharset, $lineNumber = 0)
     {
@@ -48,9 +48,9 @@ public function __construct(CSSString $oCharset, $lineNumber = 0)
     }
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo()
+    public function getLineNo(): int
     {
         return $this->lineNumber;
     }
diff --git a/src/Property/Import.php b/src/Property/Import.php
@@ -24,7 +24,7 @@ class Import implements AtRule
     private $mediaQuery;
 
     /**
-     * @var int
+     * @var int<0, max>
      *
      * @internal since 8.8.0
      */
@@ -39,7 +39,7 @@ class Import implements AtRule
 
     /**
      * @param string $mediaQuery
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct(URL $location, $mediaQuery, $lineNumber = 0)
     {
@@ -50,9 +50,9 @@ public function __construct(URL $location, $mediaQuery, $lineNumber = 0)
     }
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo()
+    public function getLineNo(): int
     {
         return $this->lineNumber;
     }
diff --git a/src/Renderable.php b/src/Renderable.php
@@ -6,18 +6,12 @@
 
 interface Renderable
 {
-    /**
-     * @return string
-     */
-    public function __toString();
+    public function __toString(): string;
 
-    /**
-     * @return string
-     */
-    public function render(OutputFormat $oOutputFormat);
+    public function render(OutputFormat $oOutputFormat): string;
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo();
+    public function getLineNo(): int;
 }
diff --git a/src/Rule/Rule.php b/src/Rule/Rule.php
@@ -62,7 +62,7 @@ class Rule implements Renderable, Commentable
 
     /**
      * @param string $sRule
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      * @param int $iColNo
      */
     public function __construct($sRule, $lineNumber = 0, $iColNo = 0)
@@ -141,9 +141,9 @@ private static function listDelimiterForRule($sRule): array
     }
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo()
+    public function getLineNo(): int
     {
         return $this->lineNumber;
     }
diff --git a/src/RuleSet/AtRuleSet.php b/src/RuleSet/AtRuleSet.php
@@ -28,7 +28,7 @@ class AtRuleSet extends RuleSet implements AtRule
     /**
      * @param string $sType
      * @param string $sArgs
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($sType, $sArgs = '', $lineNumber = 0)
     {
diff --git a/src/RuleSet/DeclarationBlock.php b/src/RuleSet/DeclarationBlock.php
@@ -30,7 +30,7 @@ class DeclarationBlock extends RuleSet
     private $aSelectors;
 
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($lineNumber = 0)
     {
diff --git a/src/RuleSet/RuleSet.php b/src/RuleSet/RuleSet.php
@@ -30,7 +30,7 @@ abstract class RuleSet implements Renderable, Commentable
     private $aRules;
 
     /**
-     * @var int
+     * @var int<0, max>
      *
      * @internal since 8.8.0
      */
@@ -44,7 +44,7 @@ abstract class RuleSet implements Renderable, Commentable
     protected $comments;
 
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($lineNumber = 0)
     {
@@ -94,9 +94,9 @@ public static function parseRuleSet(ParserState $parserState, RuleSet $ruleSet):
     }
 
     /**
-     * @return int
+     * @return int<0, max>
      */
-    public function getLineNo()
+    public function getLineNo(): int
     {
         return $this->lineNumber;
     }
diff --git a/src/Value/CSSFunction.php b/src/Value/CSSFunction.php
@@ -24,7 +24,7 @@ class CSSFunction extends ValueList
      * @param string $sName
      * @param RuleValueList|array<array-key, Value|string> $aArguments
      * @param string $sSeparator
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($sName, $aArguments, $sSeparator = ',', $lineNumber = 0)
     {
diff --git a/src/Value/CSSString.php b/src/Value/CSSString.php
@@ -24,7 +24,7 @@ class CSSString extends PrimitiveValue
 
     /**
      * @param string $sString
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($sString, $lineNumber = 0)
     {
diff --git a/src/Value/CalcRuleValueList.php b/src/Value/CalcRuleValueList.php
@@ -9,17 +9,14 @@
 class CalcRuleValueList extends RuleValueList
 {
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($lineNumber = 0)
     {
         parent::__construct(',', $lineNumber);
     }
 
-    /**
-     * @return string
-     */
-    public function render(OutputFormat $oOutputFormat)
+    public function render(OutputFormat $oOutputFormat): string
     {
         return $oOutputFormat->implode(' ', $this->aComponents);
     }
diff --git a/src/Value/Color.php b/src/Value/Color.php
@@ -17,7 +17,7 @@ class Color extends CSSFunction
 {
     /**
      * @param array<array-key, Value|string> $colorValues
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct(array $colorValues, $lineNumber = 0)
     {
diff --git a/src/Value/LineName.php b/src/Value/LineName.php
@@ -13,7 +13,7 @@ class LineName extends ValueList
 {
     /**
      * @param array<int, Value|string> $aComponents
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct(array $aComponents = [], $lineNumber = 0)
     {
diff --git a/src/Value/PrimitiveValue.php b/src/Value/PrimitiveValue.php
@@ -7,7 +7,7 @@
 abstract class PrimitiveValue extends Value
 {
     /**
-     * @param int $lineNumber
+     * @param int<0, max> $lineNumber
      */
     public function __construct($lineNumber = 0)
     {
diff --git a/src/Value/RuleValueList.php b/src/Value/RuleValueList.php
diff --git a/src/Value/Size.php b/src/Value/Size.php
diff --git a/src/Value/URL.php b/src/Value/URL.php
diff --git a/src/Value/Value.php b/src/Value/Value.php
diff --git a/src/Value/ValueList.php b/src/Value/ValueList.php

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class AtRuleBlockList extends CSSBlockList implements AtRule`
`25`	`25`	`/**`
`26`	`26`	`* @param string $type`
`27`	`27`	`* @param string $arguments`
`28`		`- * @param int $lineNumber`
	`28`	`+ * @param int<0, max> $lineNumber`
`29`	`29`	`*/`
`30`	`30`	`public function __construct($type, $arguments = '', $lineNumber = 0)`
`31`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`abstract class CSSBlockList extends CSSList`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`		`- * @param int $lineNumber`
	`24`	`+ * @param int<0, max> $lineNumber`
`25`	`25`	`*/`
`26`	`26`	`public function __construct($lineNumber = 0)`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -48,14 +48,14 @@ abstract class CSSList implements Renderable, Commentable`
`48`	`48`	`protected $contents;`
`49`	`49`
`50`	`50`	`/**`
`51`		`- * @var int`
	`51`	`+ * @var int<0, max>`
`52`	`52`	`*`
`53`	`53`	`* @internal since 8.8.0`
`54`	`54`	`*/`
`55`	`55`	`protected $lineNumber;`
`56`	`56`
`57`	`57`	`/**`
`58`		`- * @param int $lineNumber`
	`58`	`+ * @param int<0, max> $lineNumber`
`59`	`59`	`*/`
`60`	`60`	`public function __construct($lineNumber = 0)`
`61`	`61`	`{`
`@@ -255,9 +255,9 @@ private static function identifierIs($identifier, string $match): bool`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`/**`
`258`		`- * @return int`
	`258`	`+ * @return int<0, max>`
`259`	`259`	`*/`
`260`		`- public function getLineNo()`
	`260`	`+ public function getLineNo(): int`
`261`	`261`	`{`
`262`	`262`	`return $this->lineNumber;`
`263`	`263`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`class Document extends CSSBlockList`
`20`	`20`	`{`
`21`	`21`	`/**`
`22`		`- * @param int $lineNumber`
	`22`	`+ * @param int<0, max> $lineNumber`
`23`	`23`	`*/`
`24`	`24`	`public function __construct($lineNumber = 0)`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class KeyFrame extends CSSList implements AtRule`
`20`	`20`	`private $animationName;`
`21`	`21`
`22`	`22`	`/**`
`23`		`- * @param int $lineNumber`
	`23`	`+ * @param int<0, max> $lineNumber`
`24`	`24`	`*/`
`25`	`25`	`public function __construct($lineNumber = 0)`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`class Comment implements Renderable`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`		`- * @var int`
	`13`	`+ * @var int<0, max>`
`14`	`14`	`*`
`15`	`15`	`* @internal since 8.8.0`
`16`	`16`	`*/`
`@@ -25,7 +25,7 @@ class Comment implements Renderable`
`25`	`25`
`26`	`26`	`/**`
`27`	`27`	`* @param string $commentText`
`28`		`- * @param int $lineNumber`
	`28`	`+ * @param int<0, max> $lineNumber`
`29`	`29`	`*/`
`30`	`30`	`public function __construct($commentText = '', $lineNumber = 0)`
`31`	`31`	`{`
`@@ -42,9 +42,9 @@ public function getComment()`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * @return int`
	`45`	`+ * @return int<0, max>`
`46`	`46`	`*/`
`47`		`- public function getLineNo()`
	`47`	`+ public function getLineNo(): int`
`48`	`48`	`{`
`49`	`49`	`return $this->lineNumber;`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class Parser`
`20`	`20`
`21`	`21`	`/**`
`22`	`22`	`* @param string $sText the complete CSS as text (i.e., usually the contents of a CSS file)`
`23`		`- * @param int $lineNumber the line number (starting from 1, not from 0)`
	`23`	`+ * @param int<0, max> $lineNumber the line number (starting from 1, not from 0)`
`24`	`24`	`*/`
`25`	`25`	`public function __construct($sText, ?Settings $oParserSettings = null, $lineNumber = 1)`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ final class OutputException extends SourceException`
`11`	`11`	`{`
`12`	`12`	`/**`
`13`	`13`	`* @param string $sMessage`
`14`		`- * @param int $lineNumber`
	`14`	`+ * @param int<0, max> $lineNumber`
`15`	`15`	`*/`
`16`	`16`	`public function __construct($sMessage, $lineNumber = 0)`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ class ParserState`
`58`	`58`
`59`	`59`	`/**`
`60`	`60`	`* @param string $sText the complete CSS as text (i.e., usually the contents of a CSS file)`
`61`		`- * @param int $lineNumber`
	`61`	`+ * @param int<0, max> $lineNumber`
`62`	`62`	`*/`
`63`	`63`	`public function __construct($sText, Settings $oParserSettings, $lineNumber = 1)`
`64`	`64`	`{`