PHPDoc @var singleton (PhpStorm)

Question

My PhpStorm can't find the method of an singleton class when I direct call it.

this works:

$db = Database::getInstance();
/** @var Database $db */
$this->db = $db->getDatabase(IMS_DB);

this not

/** @var Database Database::getInstance */
$this->db = Database::getInstance()->getDatabase(IMS_DB);

It says cannot find method getDatabase.

Any Ideas?

Hi and welcome to Stack Overflow, please take a time to go through the welcome tour to know your way around here (and also to earn your first badge), read how to create a Minimal, Complete, and Verifiable example and also check How to Ask Good Questions so you increase your chances to get feedback and useful answers. — DarkCygnus
– DarkCygnus, Commented Jul 10, 2017 at 18:18
Please elaborate by giving a more detailed example and describe exactly what step you took and what didn't work as expected. — herrbischoff
– herrbischoff, Commented Jul 10, 2017 at 18:21
"Any Ideas?" yes -- you last PHPDoc is wrong -- it does not work like that. You cannot typehint some method in another class this way. Typehinting like that works for local variables (like in first place, where you typehint $db variable). If you need typehint return type of Database::getInstance() then it has to be done in that Database class. — LazyOne
– LazyOne, Commented Jul 10, 2017 at 18:54
Your right. @LazyOne i made a mistake at the Database Class. Set the right return type there fixed the problem. Thx — Sebastian
– Sebastian, Commented Jul 11, 2017 at 7:39

Tomáš Staník · Accepted Answer · 2019-02-14 13:51:36Z

1

You need to teach your IDE what getInstance() is actually returning, so you need to add phpDoc to Database::getInstance().

class Database

/**
* @return self
*/
public static function getInstance(){
    //code...
}

answered Feb 14, 2019 at 13:51

Tomáš Staník

1,4671 gold badge11 silver badges23 bronze badges

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

1 Answer 1