Skip to content

[TASK] Use native type declarations for Renderable #891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/CSSList/AtRuleBlockList.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/CSSList/CSSBlockList.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
abstract class CSSBlockList extends CSSList
{
/**
* @param int $lineNumber
* @param int<0, max> $lineNumber
*/
public function __construct($lineNumber = 0)
{
Expand Down
8 changes: 4 additions & 4 deletions src/CSSList/CSSList.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion src/CSSList/Document.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
class Document extends CSSBlockList
{
/**
* @param int $lineNumber
* @param int<0, max> $lineNumber
*/
public function __construct($lineNumber = 0)
{
Expand Down
2 changes: 1 addition & 1 deletion src/CSSList/KeyFrame.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
8 changes: 4 additions & 4 deletions src/Comment/Comment.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
class Comment implements Renderable
{
/**
* @var int
* @var int<0, max>
*
* @internal since 8.8.0
*/
Expand All @@ -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)
{
Expand All @@ -42,9 +42,9 @@ public function getComment()
}

/**
* @return int
* @return int<0, max>
*/
public function getLineNo()
public function getLineNo(): int
{
return $this->lineNumber;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Parser.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Parsing/OutputException.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Parsing/ParserState.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
6 changes: 3 additions & 3 deletions src/Parsing/SourceException.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand All @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Parsing/UnexpectedTokenException.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
6 changes: 3 additions & 3 deletions src/Property/CSSNamespace.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand All @@ -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;
}
Expand Down
8 changes: 4 additions & 4 deletions src/Property/Charset.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class Charset implements AtRule
private $oCharset;

/**
* @var int
* @var int<0, max>
*
* @internal since 8.8.0
*/
Expand All @@ -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)
{
Expand All @@ -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;
}
Expand Down
8 changes: 4 additions & 4 deletions src/Property/Import.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class Import implements AtRule
private $mediaQuery;

/**
* @var int
* @var int<0, max>
*
* @internal since 8.8.0
*/
Expand All @@ -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)
{
Expand All @@ -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;
}
Expand Down
14 changes: 4 additions & 10 deletions src/Renderable.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
6 changes: 3 additions & 3 deletions src/Rule/Rule.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion src/RuleSet/AtRuleSet.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/RuleSet/DeclarationBlock.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class DeclarationBlock extends RuleSet
private $aSelectors;

/**
* @param int $lineNumber
* @param int<0, max> $lineNumber
*/
public function __construct($lineNumber = 0)
{
Expand Down
8 changes: 4 additions & 4 deletions src/RuleSet/RuleSet.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ abstract class RuleSet implements Renderable, Commentable
private $aRules;

/**
* @var int
* @var int<0, max>
*
* @internal since 8.8.0
*/
Expand All @@ -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)
{
Expand Down Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Value/CSSFunction.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Value/CSSString.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
7 changes: 2 additions & 5 deletions src/Value/CalcRuleValueList.php
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
2 changes: 1 addition & 1 deletion src/Value/Color.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Value/LineName.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Value/PrimitiveValue.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
abstract class PrimitiveValue extends Value
{
/**
* @param int $lineNumber
* @param int<0, max> $lineNumber
*/
public function __construct($lineNumber = 0)
{
Expand Down
Loading