Skip to content

Add support and tests for $this type assertions #2609

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
ondrejmirtes merged 1 commit into from
Sep 7, 2023
Merged

Add support and tests for $this type assertions #2609

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
1 change: 1 addition & 0 deletions tests/PHPStan/Analyser/NodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1151,6 +1151,7 @@ public function dataFileAsserts(): iterable
yield from $this->gatherAssertTypes(__DIR__ . '/data/assert-empty.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/assert-method.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/assert-property.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/assert-this.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/assert-methods.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/assert-intersected.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/assert-invariant.php');
Expand Down
84 changes: 84 additions & 0 deletions tests/PHPStan/Analyser/data/assert-this.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<?php

namespace AssertThis;

use RuntimeException;

use function PHPStan\Testing\assertType;

/**
* @template TOk
* @template TErr
*/
interface Result {
/**
* @phpstan-assert-if-true Ok<TOk> $this
* @phpstan-assert-if-false Err<TErr> $this
*/
public function isOk(): bool;

/**
* @return TOk|never
*/
public function unwrap();
}

/**
* @template TOk
* @template-implements Result<TOk, never>
*/
class Ok implements Result {
public function __construct(private $value) {
}

/**
* @return true
*/
public function isOk(): bool {
return true;
}

/**
* @return TOk
*/
public function unwrap() {
return $this->value;
}
}

/**
* @template TErr
* @template-implements Result<never, TErr>
*/
class Err implements Result {
public function __construct(private $value) {
}

/**
* @return false
*/
public function isOk(): bool {
return false;
}

/**
* @return never
*/
public function unwrap() {
throw new RuntimeException('Tried to unwrap() an Err value');
}
}

function () {
/** @var Result<int, string> $result */
$result = new Ok(123);
assertType('AssertThis\\Result<int, string>', $result);

if ($result->isOk()) {
assertType('AssertThis\\Ok<int>', $result);
assertType('int', $result->unwrap());
} else {
assertType('AssertThis\\Err<string>', $result);
assertType('never', $result->unwrap());
}
};