Jon Jon - 5 years ago 249
PHP Question

How to deal with "method not found in class" warning for magically implemented methods?

I am sitting on a large codebase that contains several classes that expose functionality through magically implemented methods (using

__call
and
__callStatic
). For example:

class Foo {
public function __call($name, $parameters) {
echo "You called $name().\n";
}
}

$f = new Foo;
$f->test(); // runs fine, but PhpStorm flags as a warning


The problem is that PhpStorm thinks that the
test()
method does not exist, so it gives a warning at the call site. This is a little annoying, as of course the code will run and behave as expected.

I have already tuned down the severity by checking the "downgrade severity if __magic methods are present in class" option, but I would prefer to either:


  1. completely disable this functionality for specific classes only, or

  2. work with the IDE rather than against it -- provide it with the information I already have so our views agree



Is any of the above possible? If so, how?

Additional bonus question: consider the case where method calls are being chained.

$f = new Foo;
$f->test()->chain()->moreChain(); // potentially runs fine


Assuming that the magic call to
$f->test()
returns something appropriate the subsequent (possibly, but not necessarily, also magic) calls will work fine. However, since there is no way that I know of to tell the IDE what
test()
returns it flags the rest of the call chain as full of missing methods too. And to make matters worse, the "downgrade severity" setting does not apply to these warnings since the IDE does not know what class these intermediate objects are supposed to be.

Is there a solution that can also cover this case?

Update



Even though documenting the magic methods with
@method
annotations seems to work, I have to assume that there are currently several problems with this approach because it only took me a little work to come upon these related bugs:



I do hope they fix them in a reasonable time frame.

Answer Source

Well, you can go to the preference menu, under Inspections, go to Undefined -> Undefined Method and check Downgrade severity if __magic methods are present.

That would make the flag less severe, (instead of Warning, as Info), which would still give you a green light on your document check.

There's nothing else I'm aware of aside from having @property or @method PHPDoc notations on the target class for every method that's likely to be used.

enter image description here

Recommended from our users: Dynamic Network Monitoring from WhatsUp Gold from IPSwitch. Free Download