DynamicMethodReturnTypeExtension - Accessing variable initialization information

[EtienneBruines]

In this example:

$query = MyModel::findBySql("");
$query->all();

I know the all() method will return a MyModel[], but I have not found any way of accessing the line that declares $query. The variable $query is of an ancestor-type of MyModel, so that does not help.

---

Second example, which was easier:

MyModel::findBySql("")->all();

Here I accessed $methodCall->var->class to know it was of class MyModel. I'm looking for exactly this information in the first example.

---

I acknowledge that this will not work if $query is passed in through a function, but it's a start. For a Query-Builder, it might be common practice to save it to a variable before fetching final results (e.g. to optionally add a WHERE or ORDER BY clause).

[ondrejmirtes]

Hi, how is MyModel::findBySql typehinted? Ideally it should return MyModel and you'd be done :) Feel free to post the MyModel (and possibly ancestors) to phpstan.org and we'll tag the code correctly so that it just works without an extension.

[EtienneBruines]

@ondrejmirtes thank you for your ridiculously quick reply! 😄

https://phpstan.org/r/7239873a-7564-4138-b09e-4c686d2babb0

<?php declare(strict_types = 1);


class ActiveQuery {
    public function all() {}
}

class ActiveRecord {
    /** 
	* @param string $sql
	* @return ActiveQuery 
	*/
    public function findBySql($sql) { return new ActiveQuery(); }
}

class MyModel extends ActiveRecord {}

The issue has been, that when phpstan told me it was of class ActiveRecord, I don't know how to get back to knowing it's of class MyModel.

[ondrejmirtes]

Generics to the rescue! :) https://phpstan.org/r/7f072318-0130-41de-beb9-d547c4a92879

[ondrejmirtes]

Read more about it here: https://phpstan.org/blog/generics-in-php-using-phpdocs

[EtienneBruines]

That is awesome!

Are generics also accessible from a DynamicMethodReturnTypeExtension? As we do not have direct access to the source code of ActiveQuery and ActiveRecord (different repo, different maintainers).

Basically looking at defining that template for ActiveQuery and ActiveRecord within a DynamicMethodReturnTypeExtension.

[ondrejmirtes]

You can do something easier, there's Stub files feature for overriding 3rd party PHPDocs: https://phpstan.org/user-guide/stub-files