Stub files not overriding @method annotations

[ndench]

Bug report

I'm trying to write a stub file for FakerPHP/Faker, specifically for the randomElement() method which is defined by an @method annotation. It appears that my stub file is being completely ignored and I cannot figure out why.

I've enabled xdebug and stepped through the analyse command to ensure that the stub is being read. This is backed up by phpstan displaying errors if I make the stub file invalid.

Code snippet that reproduces the problem

Here is a snippet which shows the error: https://phpstan.org/r/263ad808-dab7-4003-b7be-b816c02c1401

Here is the stub file I've written:

// Generator.stub
<?php

namespace Faker;

class Generator
{
    /**
     * @template T
     * @param array<array-key, T> $array
     *
     * @return T
     */
    public function randomElement(array $array): mixed;
}

To test further, I changed the stub file in a way that should make any call to ->randomElement() throw an error. But no errors were reported at all.

// Generator.stub
<?php

namespace Faker;

class Generator
{
    /**
     * @param string $array
     * @return string
     */
    public function randomElement(string $array): string;
}

Expected output

I expected the stub file to inform PHPStan of the return type for randomElement.

Did PHPStan help you today? Did it make you happy in any way?

I've been using PHPStan for almost 4 years, and I'm very impressed with the speed improvements over that time ❤️

[ondrejmirtes]

Thank you for your kind words! :)

Stub files are for overriding PHPDocs only. If you want to fix that wrong @method annotation, you have the copy the whole PHPDoc above the class and fix that one mistake. Better solution here is to probably send a PR to Faker itself, although @method annotations do not support generics yet: #6371

[ndench]

Right, that makes sense. Thanks for the explanation 😊

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.