Skip to content

Commit f34a543

Browse files
jrfnljrfnl
authored
Merge pull request #1116 from PHPCSStandards/php-8.4/feature/file-methods-support-asym-visibility
PHP 8.4 | File::getMemberProperties() + File::getMethodParameters(): add support for asymmetric visibility
2 parents 30fdf53 + 2e9da03 commit f34a543

File tree

6 files changed

+456
-30
lines changed

6 files changed

+456
-30
lines changed

‎src/Files/File.php‎

Lines changed: 58 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1354,6 +1354,10 @@ public function getDeclarationName($stackPtr)
13541354
* 'readonly_token' => integer, // The stack pointer to the readonly modifier token.
13551355
* // This index will only be set if the property is readonly.
13561356
*
1357+
* ... and if the promoted property uses asymmetric visibility, these additional array indexes will also be available:
1358+
* 'set_visibility' => string, // The property set-visibility as declared.
1359+
* 'set_visibility_token' => integer, // The stack pointer to the set-visibility modifier token.
1360+
*
13571361
* @param int $stackPtr The position in the stack of the function token
13581362
* to acquire the parameters for.
13591363
*
@@ -1406,10 +1410,11 @@ public function getMethodParameters($stackPtr)
14061410
$variadicToken = false;
14071411
$typeHint = '';
14081412
$typeHintToken = false;
1409-
$typeHintEndToken = false;
1410-
$nullableType = false;
1411-
$visibilityToken = null;
1412-
$readonlyToken = null;
1413+
$typeHintEndToken = false;
1414+
$nullableType = false;
1415+
$visibilityToken = null;
1416+
$setVisibilityToken = null;
1417+
$readonlyToken = null;
14131418

14141419
for ($i = $paramStart; $i <= $closer; $i++) {
14151420
// Check to see if this token has a parenthesis or bracket opener. If it does
@@ -1541,6 +1546,13 @@ public function getMethodParameters($stackPtr)
15411546
$visibilityToken = $i;
15421547
}
15431548
break;
1549+
case T_PUBLIC_SET:
1550+
case T_PROTECTED_SET:
1551+
case T_PRIVATE_SET:
1552+
if ($defaultStart === null) {
1553+
$setVisibilityToken = $i;
1554+
}
1555+
break;
15441556
case T_READONLY:
15451557
if ($defaultStart === null) {
15461558
$readonlyToken = $i;
@@ -1575,16 +1587,21 @@ public function getMethodParameters($stackPtr)
15751587
$vars[$paramCount]['type_hint_end_token'] = $typeHintEndToken;
15761588
$vars[$paramCount]['nullable_type'] = $nullableType;
15771589

1578-
if ($visibilityToken !== null || $readonlyToken !== null) {
1590+
if ($visibilityToken !== null || $setVisibilityToken !== null || $readonlyToken !== null) {
15791591
$vars[$paramCount]['property_visibility'] = 'public';
15801592
$vars[$paramCount]['visibility_token'] = false;
1581-
$vars[$paramCount]['property_readonly'] = false;
15821593

15831594
if ($visibilityToken !== null) {
15841595
$vars[$paramCount]['property_visibility'] = $this->tokens[$visibilityToken]['content'];
15851596
$vars[$paramCount]['visibility_token'] = $visibilityToken;
15861597
}
15871598

1599+
if ($setVisibilityToken !== null) {
1600+
$vars[$paramCount]['set_visibility'] = $this->tokens[$setVisibilityToken]['content'];
1601+
$vars[$paramCount]['set_visibility_token'] = $setVisibilityToken;
1602+
}
1603+
1604+
$vars[$paramCount]['property_readonly'] = false;
15881605
if ($readonlyToken !== null) {
15891606
$vars[$paramCount]['property_readonly'] = true;
15901607
$vars[$paramCount]['readonly_token'] = $readonlyToken;
@@ -1598,21 +1615,22 @@ public function getMethodParameters($stackPtr)
15981615
}
15991616

16001617
// Reset the vars, as we are about to process the next parameter.
1601-
$currVar = null;
1602-
$paramStart = ($i + 1);
1603-
$defaultStart = null;
1604-
$equalToken = null;
1605-
$hasAttributes = false;
1606-
$passByReference = false;
1607-
$referenceToken = false;
1608-
$variableLength = false;
1609-
$variadicToken = false;
1610-
$typeHint = '';
1611-
$typeHintToken = false;
1612-
$typeHintEndToken = false;
1613-
$nullableType = false;
1614-
$visibilityToken = null;
1615-
$readonlyToken = null;
1618+
$currVar = null;
1619+
$paramStart = ($i + 1);
1620+
$defaultStart = null;
1621+
$equalToken = null;
1622+
$hasAttributes = false;
1623+
$passByReference = false;
1624+
$referenceToken = false;
1625+
$variableLength = false;
1626+
$variadicToken = false;
1627+
$typeHint = '';
1628+
$typeHintToken = false;
1629+
$typeHintEndToken = false;
1630+
$nullableType = false;
1631+
$visibilityToken = null;
1632+
$setVisibilityToken = null;
1633+
$readonlyToken = null;
16161634

16171635
$paramCount++;
16181636
break;
@@ -1827,6 +1845,9 @@ public function getMethodProperties($stackPtr)
18271845
* array(
18281846
* 'scope' => string, // Public, private, or protected.
18291847
* 'scope_specified' => boolean, // TRUE if the scope was explicitly specified.
1848+
* 'set_scope' => string|false, // Scope for asymmetric visibility.
1849+
* // Either public, private, or protected or
1850+
* // FALSE if no set scope is specified.
18301851
* 'is_static' => boolean, // TRUE if the static keyword was found.
18311852
* 'is_readonly' => boolean, // TRUE if the readonly keyword was found.
18321853
* 'is_final' => boolean, // TRUE if the final keyword was found.
@@ -1896,19 +1917,18 @@ public function getMemberProperties($stackPtr)
18961917
}
18971918

18981919
$valid = [
1899-
T_PUBLIC => T_PUBLIC,
1900-
T_PRIVATE => T_PRIVATE,
1901-
T_PROTECTED => T_PROTECTED,
1902-
T_STATIC => T_STATIC,
1903-
T_VAR => T_VAR,
1904-
T_READONLY => T_READONLY,
1905-
T_FINAL => T_FINAL,
1920+
T_STATIC => T_STATIC,
1921+
T_VAR => T_VAR,
1922+
T_READONLY => T_READONLY,
1923+
T_FINAL => T_FINAL,
19061924
];
19071925

1926+
$valid += Tokens::$scopeModifiers;
19081927
$valid += Tokens::$emptyTokens;
19091928

19101929
$scope = 'public';
19111930
$scopeSpecified = false;
1931+
$setScope = false;
19121932
$isStatic = false;
19131933
$isReadonly = false;
19141934
$isFinal = false;
@@ -1941,6 +1961,15 @@ public function getMemberProperties($stackPtr)
19411961
$scope = 'protected';
19421962
$scopeSpecified = true;
19431963
break;
1964+
case T_PUBLIC_SET:
1965+
$setScope = 'public';
1966+
break;
1967+
case T_PROTECTED_SET:
1968+
$setScope = 'protected';
1969+
break;
1970+
case T_PRIVATE_SET:
1971+
$setScope = 'private';
1972+
break;
19441973
case T_STATIC:
19451974
$isStatic = true;
19461975
break;
@@ -2004,6 +2033,7 @@ public function getMemberProperties($stackPtr)
20042033
return [
20052034
'scope' => $scope,
20062035
'scope_specified' => $scopeSpecified,
2036+
'set_scope' => $setScope,
20072037
'is_static' => $isStatic,
20082038
'is_readonly' => $isReadonly,
20092039
'is_final' => $isFinal,

‎src/Standards/PSR2/Tests/Classes/PropertyDeclarationUnitTest.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ public function getErrorList()
6464
101 => 2,
6565
105 => 1,
6666
107 => 1,
67-
109 => 1,
68-
111 => 1,
6967
];
7068

7169
}//end getErrorList()

‎tests/Core/Files/File/GetMemberPropertiesTest.inc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,3 +375,29 @@ class WithFinalProperties {
375375
/* testPHP84FinalComplexTypedProp */
376376
final public (Foo&\Bar)|bool $val9;
377377
}
378+
379+
class AsymVisibility {
380+
/* testPHP84AsymPublicSetProperty */
381+
public(set) mixed $prop1;
382+
/* testPHP84AsymPublicPublicSetProperty */
383+
public public(set) (A&B)|null $prop2;
384+
/* testPHP84AsymPublicSetPublicProperty */
385+
public(set) public bool $prop3;
386+
387+
/* testPHP84AsymProtectedSetProperty */
388+
protected(set) readonly mixed $prop4;
389+
/* testPHP84AsymPublicProtectedSetProperty */
390+
public protected(set) string $prop5;
391+
/* testPHP84AsymProtectedSetPublicProperty */
392+
protected(set) public ?float $prop6;
393+
394+
/* testPHP84AsymPrivateSetProperty */
395+
private(set) string|int $prop7;
396+
/* testPHP84AsymProtectedPrivateSetProperty */
397+
final protected private(set) $prop8;
398+
/* testPHP84AsymPrivateSetPublicProperty */
399+
private(set) public mixed $prop9;
400+
401+
/* testPHP84IllegalAsymPublicProtectedSetStaticProperty */
402+
public protected(set) static mixed $prop10;
403+
}

0 commit comments

Comments
 (0)