Is the stub analysis using different autoloading from the rest of the project?

[tomasfejfar]

When running analysis in the actual project using stub from my extension I get a bunch of errors.

Generally they are:
@implements has invalid type
template for class has invalid bound type
... has invalid type

Full list follows

------ ---------------------------------------------------------------------------------------------------------------------------
  Line   legacy-app/vendor/tomasfejfar/phpstan-zf1/stubs/Zend_Db_Table_Rowset_Abstract.stub
 ------ ---------------------------------------------------------------------------------------------------------------------------
  30     PHPDoc tag @implements has invalid type Zend_Db_Table_Row_Abstract.
  30     PHPDoc tag @implements has invalid type Zend_Db_Table_Row_Abstract.
  30     PHPDoc tag @template TTable for class Zend_Db_Table_Rowset_Abstract has invalid bound type Zend_Db_Table_Abstract.
  30     PHPDoc tag @template TValue for class Zend_Db_Table_Rowset_Abstract has invalid bound type Zend_Db_Table_Row_Abstract.
  44     Property Zend_Db_Table_Rowset_Abstract::$_table has unknown class Zend_Db_Table_Abstract as its type.
  60     Property Zend_Db_Table_Rowset_Abstract::$_tableClass has unknown class Zend_Db_Table_Abstract as its type.
  67     Property Zend_Db_Table_Rowset_Abstract::$_rowClass has unknown class Zend_Db_Table_Row_Abstract as its type.
  88     Property Zend_Db_Table_Rowset_Abstract::$_rows has unknown class Zend_Db_Table_Row_Abstract as its type.
  145    Return typehint of method Zend_Db_Table_Rowset_Abstract::getTable() has invalid type Zend_Db_Table_Abstract.
  155    PHPDoc tag @param for parameter $table with type TTable of Zend_Db_Table_Abstract is not subtype of native type TTable.
  155    PHPDoc tag @throws with type Zend_Db_Table_Row_Exception is not subtype of Throwable
  155    Parameter $table of method Zend_Db_Table_Rowset_Abstract::setTable() has invalid typehint type TTable.
  155    Parameter $table of method Zend_Db_Table_Rowset_Abstract::setTable() has invalid typehint type Zend_Db_Table_Abstract.
  172    Return typehint of method Zend_Db_Table_Rowset_Abstract::rewind() has invalid type Zend_Db_Table_Abstract.
  172    Return typehint of method Zend_Db_Table_Rowset_Abstract::rewind() has invalid type Zend_Db_Table_Row_Abstract.
  181    Return typehint of method Zend_Db_Table_Rowset_Abstract::current() has invalid type Zend_Db_Table_Row_Abstract.
  227    PHPDoc tag @throws with type Zend_Db_Table_Rowset_Exception is not subtype of Throwable
  227    Return typehint of method Zend_Db_Table_Rowset_Abstract::seek() has invalid type Zend_Db_Table_Abstract.
  227    Return typehint of method Zend_Db_Table_Rowset_Abstract::seek() has invalid type Zend_Db_Table_Row_Abstract.
  245    Return typehint of method Zend_Db_Table_Rowset_Abstract::offsetGet() has invalid type Zend_Db_Table_Row_Abstract.
  272    PHPDoc tag @throws with type Zend_Db_Table_Rowset_Exception is not subtype of Throwable
  272    Return typehint of method Zend_Db_Table_Rowset_Abstract::getRow() has invalid type Zend_Db_Table_Row.
  287    Return typehint of method Zend_Db_Table_Rowset_Abstract::_loadAndReturnRow() has invalid type Zend_Db_Table_Row_Abstract.
 ------ ---------------------------------------------------------------------------------------------------------------------------

I don't have any specific autoloading rules in the project and I'm using composer autoloader everywhere. The abovementioned classes are normally autoloaded in the code.

This leads me to suspect that the stub is analysed outside of the normal code (e.g. before the project's autoloader is used).

My another suspicion was that it has a problem with FQCN vs missing heading slash in the definition:

/**
 * @template TValue of \Zend_Db_Table_Row_Abstract <---- backslash here
 * @template TTable of \Zend_Db_Table_Abstract
 * @template TKey of int
 * @implements SeekableIterator<TKey, TValue>
 * @implements ArrayAccess<TKey, TValue>
 */
abstract class Zend_Db_Table_Rowset_Abstract implements SeekableIterator, Countable, ArrayAccess

But that is not the case, neither with or without works. Also the type Zend_Db_Table_Rowset_Exception is not subtype of Throwable error points toward a problem with autoloading because the exception is fairly standard.

[ondrejmirtes]

Please read this webpage carefully and all your concerns will be answered: https://phpstan.org/user-guide/stub-files

[tomasfejfar]

🙈 sorry

[CoalaJoe]

So for anyone wanting to save themself some time and a concise answer.

Like @ondrejmirtes hinted to the website:

...
To mitigate this, you can write a stub file with the right PHPDoc. It’s like source code, but PHPStan only reads PHPDocs from it. So the namespace and class/interface/trait/method/function names must match with the original source you’re describing. Method bodies can stay empty, PHPStan is only interested in the PHPDocs.
...

This means, use-statements will be ignored and you should use full namespaces in your phpdoc.

[ondrejmirtes]

and you should use full namespaces in your phpdoc

No, it does not mean that. You can still use use statements in your stubs.

[CoalaJoe]

Really? It was kinda bugging when I had the use statements. (currently using 1.10.59)

Since there is no example on the docs, do you know where one can see an actual example on how the stub should look like?

[ondrejmirtes]

There are many examples in phpstan-src and in all the major extensions like phpstan-doctrine or phpstan-symfony.

Always in root directory in "stubs/".

[CoalaJoe]

Thanks, will take a look there. 👍🏻