Skip to content

[TASK] Add native type declarations for CSSFunction #1197

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.

Sign up for GitHub

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 2 commits into from
Mar 19, 2025
Merged

[TASK] Add native type declarations for CSSFunction #1197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34ca3e9
[TASK] Add native type declarations for `CSSFunction`
oliverklee Mar 19, 2025
0b6cca9
Changes suggested in code review
oliverklee Mar 19, 2025
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
22 changes: 11 additions & 11 deletions src/Value/CSSFunction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@
class CSSFunction extends ValueList
{
/**
* @var string
* @var non-empty-string
*
* @internal since 8.8.0
*/
protected $name;

/**
* @param string $name
* @param RuleValueList|array<array-key, Value|string> $arguments
* @param string $separator
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be a non-empty-string as well?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can indeed, and should be. Changed.

* @param non-empty-string $name
* @param RuleValueList|array<Value|string> $arguments
* @param non-empty-string $separator
* @param int<0, max> $lineNumber
*/
public function __construct($name, $arguments, $separator = ',', int $lineNumber = 0)
public function __construct(string $name, $arguments, string $separator = ',', int $lineNumber = 0)
{
if ($arguments instanceof RuleValueList) {
$separator = $arguments->getListSeparator();
Expand Down Expand Up @@ -82,25 +82,25 @@ private static function parseArguments(ParserState $parserState)
}

/**
* @return string
* @return non-empty-string
*/
public function getName()
public function getName(): string
{
return $this->name;
}

/**
* @param string $name
* @param non-empty-string $name
*/
public function setName($name): void
public function setName(string $name): void
{
$this->name = $name;
}

/**
* @return array<array-key, Value|string>
* @return array<Value|string>
*/
public function getArguments()
public function getArguments(): array
{
return $this->components;
}
Expand Down
4 changes: 2 additions & 2 deletions src/Value/Color.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,9 @@ public function setColor(array $colorValues): void
}

/**
* @return string
* @return non-empty-string
*/
public function getColorDescription()
public function getColorDescription(): string
{
return $this->getName();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Value/RuleValueList.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
class RuleValueList extends ValueList
{
/**
* @param string $separator
* @param non-empty-string $separator
* @param int<0, max> $lineNumber
*/
public function __construct($separator = ',', int $lineNumber = 0)
Expand Down
4 changes: 2 additions & 2 deletions src/Value/Value.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public function __construct(int $lineNumber = 0)
}

/**
* @param array<array-key, string> $listDelimiters
* @param array<non-empty-string> $listDelimiters
*
* @return Value|string
*
Expand All @@ -43,7 +43,7 @@ public function __construct(int $lineNumber = 0)
*/
public static function parseValue(ParserState $parserState, array $listDelimiters = [])
{
/** @var array<int, Value|string> $stack */
/** @var list<Value|string> $stack */
$stack = [];
$parserState->consumeWhiteSpace();
//Build a list of delimiters and parsed values
Expand Down
12 changes: 9 additions & 3 deletions src/Value/ValueList.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,22 @@
abstract class ValueList extends Value
{
/**
* @var array<array-key, Value|string>
* @var array<Value|string>
*
* @internal since 8.8.0
*/
protected $components;

/**
* @var string
* @var non-empty-string
*
* @internal since 8.8.0
*/
protected $separator;

/**
* @param array<Value|string>|Value|string $components
* @param string $separator
* @param non-empty-string $separator
* @param int<0, max> $lineNumber
*/
public function __construct($components = [], $separator = ',', int $lineNumber = 0)
Expand Down Expand Up @@ -67,11 +67,17 @@ public function setListComponents(array $components): void
$this->components = $components;
}

/**
* @return non-empty-string
*/
public function getListSeparator(): string
{
return $this->separator;
}

/**
* @param non-empty-string $separator
*/
public function setListSeparator(string $separator): void
{
$this->separator = $separator;
Expand Down