PhpStorm docs hint specified outcome of method

Question

Is it possible for PhpStorm to understand the outcome of a method with specified parameters or when called from a specific class to know the outcome if it's defined in the PHPDoc?

For example:

class demo {
    public static function getInstance($className)
    {
        return $className::Instance();
    }
}
class someClass {
    public function Instance() {
        return new someClass();
    }
}

class otherClass {
    public function Instance() {
        return new otherClass();
    }
}

demo::getInstance('someClass'); // PHPstorm should understand this would return someClass
demo::getInstance('otherClass'); // PHPstorm should understand this would return otherClass

At the moment my PhpStorm says

Method getInstance not found in string.

For code hinting I'd like PhpStorm to understand what sort of class is returned based on the parameter value. It would be fine to put that data in the PHPDoc or anything like that, just not additional methods please.

If you need to return method type based on passed parameter (some sort of factory/container) -- look at Advanced Metadata -- that's how Laravel IDE Helper works (for example) — LazyOne
– LazyOne, Commented May 24, 2017 at 13:59

maximkou · Accepted Answer · 2017-05-24 12:52:02Z

2

First, you call non-static methods statically.

Second, you can note return type, like this:

/**
 * @return someClass|otherClass
 */
public static function getInstance($className)
{
    return $className::Instance();
}

answered May 24, 2017 at 12:52

maximkou

5,3421 gold badge23 silver badges41 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

user936965 Over a year ago

I know it should be static, it's just an example. It's correct in my real code. If I set the return type like that it could also produce code hints from other classes instead of the class that is actually returned.

gabe3886 Over a year ago

Whilst not explicitly stated, I think the question may be asking if there's a way of PhpStorm knowing what type of class it is returning, without having to have all of the possibilities listed in the @return statement, so if I had a class Foo, which had the function Instance(), could demo::getInstance('Foo'); be known to PhpStorm without Foo being declared as a return type?

maximkou Over a year ago

@gabe3886, no. PhpStorm can only propose all variants. PhpStorm generate auto phpdoc like my answer (enumerate all possible return types).

Collectives™ on Stack Overflow

PhpStorm docs hint specified outcome of method

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related