Can I assert passed object before a call? #12101

mvorisek · 2024-11-21T21:38:20Z

mvorisek
Nov 21, 2024

I know there is @phpstan-assert to narrow the type after a function/method returns.

Example what I need:

/** @phpstan-assert-before true $object->isEntity */
public function checkType(object $object): void
{
...

I expect PHPStan to emit an error if the $o->isEntity is definitely not true like in:

$o = new M();
$o->isEntity = false;

checkType($o);

ondrejmirtes · 2024-11-22T07:47:32Z

ondrejmirtes
Nov 22, 2024
Maintainer

@phpstan-assert-before, also known as @param or native parameter type 😂

You should express this using subtypes or generics and then use @param or native parameter type. No plans for @phpstan-assert-before, because it doesn't make sense to me.

2 replies

mvorisek Nov 22, 2024
Author

Here is what I mean in demo: https://phpstan.org/r/925ac01c-ba7e-4b92-958c-95ce828b2c62

Maybe @phpstan-expect would be a better name. AFAK @param is short on this.

mvorisek Nov 22, 2024
Author

@ondrejmirtes is that currently possible or can you please leave this discussion open at least?

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Can I assert passed object before a call? #12101

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment 2 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Uh oh!

Can I assert passed object before a call? #12101

Uh oh!

Uh oh!

mvorisek Nov 21, 2024

Replies: 1 comment · 2 replies

Uh oh!

ondrejmirtes Nov 22, 2024 Maintainer

Uh oh!

mvorisek Nov 22, 2024 Author

Uh oh!

mvorisek Nov 22, 2024 Author

mvorisek
Nov 21, 2024

Replies: 1 comment 2 replies

ondrejmirtes
Nov 22, 2024
Maintainer

mvorisek Nov 22, 2024
Author

mvorisek Nov 22, 2024
Author