Skip to content

File::getMethodParameters(): allow for readonly promoted properties without visibility #3801

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 1 commit into from
May 18, 2023
Merged

File::getMethodParameters(): allow for readonly promoted properties without visibility #3801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 18 additions & 11 deletions src/Files/File.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1309,10 +1309,12 @@ public function getDeclarationName($stackPtr)
* 'default_equal_token' => integer, // The stack pointer to the equals sign.
*
* Parameters declared using PHP 8 constructor property promotion, have these additional array indexes:
* 'property_visibility' => string, // The property visibility as declared.
* 'visibility_token' => integer, // The stack pointer to the visibility modifier token.
* 'property_readonly' => bool, // TRUE if the readonly keyword was found.
* 'readonly_token' => integer, // The stack pointer to the readonly modifier token.
* 'property_visibility' => string, // The property visibility as declared.
* 'visibility_token' => integer|false, // The stack pointer to the visibility modifier token
* // or FALSE if the visibility is not explicitly declared.
* 'property_readonly' => boolean, // TRUE if the readonly keyword was found.
* 'readonly_token' => integer, // The stack pointer to the readonly modifier token.
* // This index will only be set if the property is readonly.
*
* @param int $stackPtr The position in the stack of the function token
* to acquire the parameters for.
Expand Down Expand Up @@ -1530,15 +1532,20 @@ public function getMethodParameters($stackPtr)
$vars[$paramCount]['type_hint_end_token'] = $typeHintEndToken;
$vars[$paramCount]['nullable_type'] = $nullableType;

if ($visibilityToken !== null) {
$vars[$paramCount]['property_visibility'] = $this->tokens[$visibilityToken]['content'];
$vars[$paramCount]['visibility_token'] = $visibilityToken;
if ($visibilityToken !== null || $readonlyToken !== null) {
$vars[$paramCount]['property_visibility'] = 'public';
$vars[$paramCount]['visibility_token'] = false;
$vars[$paramCount]['property_readonly'] = false;
}

if ($readonlyToken !== null) {
$vars[$paramCount]['property_readonly'] = true;
$vars[$paramCount]['readonly_token'] = $readonlyToken;
if ($visibilityToken !== null) {
$vars[$paramCount]['property_visibility'] = $this->tokens[$visibilityToken]['content'];
$vars[$paramCount]['visibility_token'] = $visibilityToken;
}

if ($readonlyToken !== null) {
$vars[$paramCount]['property_readonly'] = true;
$vars[$paramCount]['readonly_token'] = $readonlyToken;
}
}

if ($this->tokens[$i]['code'] === T_COMMA) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Core/File/GetMethodParametersTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ class ConstructorPropertyPromotionWithReadOnly {
public function __construct(public readonly ?int $promotedProp, readonly private string|bool &$promotedToo) {}
}

class ConstructorPropertyPromotionWithOnlyReadOnly {
/* testPHP81ConstructorPropertyPromotionWithOnlyReadOnly */
public function __construct(readonly Foo&Bar $promotedProp, readonly ?bool $promotedToo,) {}
}

/* testPHP8ConstructorPropertyPromotionGlobalFunction */
// Intentional fatal error. Property promotion not allowed in non-constructor, but that's not the concern of this method.
function globalFunction(private $x) {}
Expand Down
37 changes: 37 additions & 0 deletions tests/Core/File/GetMethodParametersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -846,6 +846,43 @@ public function testPHP81ConstructorPropertyPromotionWithReadOnly()
}//end testPHP81ConstructorPropertyPromotionWithReadOnly()


/**
* Verify recognition of PHP8 constructor with property promotion using PHP 8.1 readonly
* keyword without explicit visibility.
*
* @return void
*/
public function testPHP81ConstructorPropertyPromotionWithOnlyReadOnly()
{
$expected = [];
$expected[0] = [
'name' => '$promotedProp',
'content' => 'readonly Foo&Bar $promotedProp',
'has_attributes' => false,
'pass_by_reference' => false,
'variable_length' => false,
'type_hint' => 'Foo&Bar',
'nullable_type' => false,
'property_visibility' => 'public',
'property_readonly' => true,
];
$expected[1] = [
'name' => '$promotedToo',
'content' => 'readonly ?bool $promotedToo',
'has_attributes' => false,
'pass_by_reference' => false,
'variable_length' => false,
'type_hint' => '?bool',
'nullable_type' => true,
'property_visibility' => 'public',
'property_readonly' => true,
];

$this->getMethodParametersTestHelper('/* '.__FUNCTION__.' */', $expected);

}//end testPHP81ConstructorPropertyPromotionWithOnlyReadOnly()


/**
* Verify behaviour when a non-constructor function uses PHP 8 property promotion syntax.
*
Expand Down