Skip to content

Commit 3572062

Browse files
authored
[TASK] Add native type declarations for CSSFunction (#1197)
Also improve the related type annotations and declarations in other classes in order to keep things consistent and to keep Rector from changing things.
1 parent 45cd62f commit 3572062

File tree

5 files changed

+25
-19
lines changed

5 files changed

+25
-19
lines changed

src/Value/CSSFunction.php

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@
1717
class CSSFunction extends ValueList
1818
{
1919
/**
20-
* @var string
20+
* @var non-empty-string
2121
*
2222
* @internal since 8.8.0
2323
*/
2424
protected $name;
2525

2626
/**
27-
* @param string $name
28-
* @param RuleValueList|array<array-key, Value|string> $arguments
29-
* @param string $separator
27+
* @param non-empty-string $name
28+
* @param RuleValueList|array<Value|string> $arguments
29+
* @param non-empty-string $separator
3030
* @param int<0, max> $lineNumber
3131
*/
32-
public function __construct($name, $arguments, $separator = ',', int $lineNumber = 0)
32+
public function __construct(string $name, $arguments, string $separator = ',', int $lineNumber = 0)
3333
{
3434
if ($arguments instanceof RuleValueList) {
3535
$separator = $arguments->getListSeparator();
@@ -82,25 +82,25 @@ private static function parseArguments(ParserState $parserState)
8282
}
8383

8484
/**
85-
* @return string
85+
* @return non-empty-string
8686
*/
87-
public function getName()
87+
public function getName(): string
8888
{
8989
return $this->name;
9090
}
9191

9292
/**
93-
* @param string $name
93+
* @param non-empty-string $name
9494
*/
95-
public function setName($name): void
95+
public function setName(string $name): void
9696
{
9797
$this->name = $name;
9898
}
9999

100100
/**
101-
* @return array<array-key, Value|string>
101+
* @return array<Value|string>
102102
*/
103-
public function getArguments()
103+
public function getArguments(): array
104104
{
105105
return $this->components;
106106
}

src/Value/Color.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,9 +217,9 @@ public function setColor(array $colorValues): void
217217
}
218218

219219
/**
220-
* @return string
220+
* @return non-empty-string
221221
*/
222-
public function getColorDescription()
222+
public function getColorDescription(): string
223223
{
224224
return $this->getName();
225225
}

src/Value/RuleValueList.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
class RuleValueList extends ValueList
1313
{
1414
/**
15-
* @param string $separator
15+
* @param non-empty-string $separator
1616
* @param int<0, max> $lineNumber
1717
*/
1818
public function __construct($separator = ',', int $lineNumber = 0)

src/Value/Value.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public function __construct(int $lineNumber = 0)
3232
}
3333

3434
/**
35-
* @param array<array-key, string> $listDelimiters
35+
* @param array<non-empty-string> $listDelimiters
3636
*
3737
* @return Value|string
3838
*
@@ -43,7 +43,7 @@ public function __construct(int $lineNumber = 0)
4343
*/
4444
public static function parseValue(ParserState $parserState, array $listDelimiters = [])
4545
{
46-
/** @var array<int, Value|string> $stack */
46+
/** @var list<Value|string> $stack */
4747
$stack = [];
4848
$parserState->consumeWhiteSpace();
4949
//Build a list of delimiters and parsed values

src/Value/ValueList.php

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@
1515
abstract class ValueList extends Value
1616
{
1717
/**
18-
* @var array<array-key, Value|string>
18+
* @var array<Value|string>
1919
*
2020
* @internal since 8.8.0
2121
*/
2222
protected $components;
2323

2424
/**
25-
* @var string
25+
* @var non-empty-string
2626
*
2727
* @internal since 8.8.0
2828
*/
2929
protected $separator;
3030

3131
/**
3232
* @param array<Value|string>|Value|string $components
33-
* @param string $separator
33+
* @param non-empty-string $separator
3434
* @param int<0, max> $lineNumber
3535
*/
3636
public function __construct($components = [], $separator = ',', int $lineNumber = 0)
@@ -67,11 +67,17 @@ public function setListComponents(array $components): void
6767
$this->components = $components;
6868
}
6969

70+
/**
71+
* @return non-empty-string
72+
*/
7073
public function getListSeparator(): string
7174
{
7275
return $this->separator;
7376
}
7477

78+
/**
79+
* @param non-empty-string $separator
80+
*/
7581
public function setListSeparator(string $separator): void
7682
{
7783
$this->separator = $separator;

0 commit comments

Comments
 (0)