Skip to content

feat(AppFramework): extend range check to optional parameters #51116

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
blizzz merged 1 commit into from
Mar 4, 2025
Merged

feat(AppFramework): extend range check to optional parameters #51116

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
2 changes: 1 addition & 1 deletion lib/private/AppFramework/Utility/ControllerMethodReflector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public function reflect($object, string $method) {
// extract type parameter information
preg_match_all('/@param\h+(?P<type>\w+)\h+\$(?P<var>\w+)/', $docs, $matches);
$this->types = array_combine($matches['var'], $matches['type']);
preg_match_all('/@psalm-param\h+(?P<type>\w+)<(?P<rangeMin>(-?\d+|min)),\h*(?P<rangeMax>(-?\d+|max))>\h+\$(?P<var>\w+)/', $docs, $matches);
preg_match_all('/@psalm-param\h+(\?)?(?P<type>\w+)<(?P<rangeMin>(-?\d+|min)),\h*(?P<rangeMax>(-?\d+|max))>(\|null)?\h+\$(?P<var>\w+)/', $docs, $matches);
foreach ($matches['var'] as $index => $varName) {
if ($matches['type'][$index] !== 'int') {
// only int ranges are possible at the moment
Expand Down
12 changes: 11 additions & 1 deletion tests/lib/AppFramework/Utility/ControllerMethodReflectorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,11 @@ public function test3() {
/**
* @psalm-param int<-4, 42> $rangedOne
* @psalm-param int<min, max> $rangedTwo
* @psalm-param int<1, 6>|null $rangedThree
* @psalm-param ?int<-70, -30> $rangedFour
* @return void
*/
public function test4(int $rangedOne, int $rangedTwo) {
public function test4(int $rangedOne, int $rangedTwo, ?int $rangedThree, ?int $rangedFour) {
}
}

Expand Down Expand Up @@ -239,5 +241,13 @@ public function testRangeDetection(): void {
$rangeInfo2 = $reader->getRange('rangedTwo');
$this->assertSame(PHP_INT_MIN, $rangeInfo2['min']);
$this->assertSame(PHP_INT_MAX, $rangeInfo2['max']);

$rangeInfo3 = $reader->getRange('rangedThree');
$this->assertSame(1, $rangeInfo3['min']);
$this->assertSame(6, $rangeInfo3['max']);

$rangeInfo3 = $reader->getRange('rangedFour');
$this->assertSame(-70, $rangeInfo3['min']);
$this->assertSame(-30, $rangeInfo3['max']);
}
}
Loading