Умеет ли PHPStorm распознавать возвращаемый объект через статический метод?

Question

[Павел Зайцев]

Недавно установил себе эту IDE, поэтому пытаюсь разобраться, что же она умеет. Быстрее будет наглядно показать. Есть код:

<?php

class system {

    public function getSingleton(){
        return singleton::getInstance();
    }

}

class singleton{

    public static $instance  = null; // Инстанс объекта данного класса

    private function __construct() {}
    private function __clone() {}

    /******************************/
    /* Возвращаем инстанс объекта */
    public static function getInstance() {
        if ( is_null( self::$instance ) ) {
            self::$instance = new singleton;
        }
        return self::$instance;
    }
    /* Возвращаем инстанс объекта */
    /******************************/

    public function test() {
        echo '1';
    }
}

$system = new system();

$object = $system->getSingleton();

При наборе в строке $object-> я ожидаю увидеть подсказку с методами класса singleton, однако IDE выдает мне сообщение «No suggestion». Есть ли возможность научить IDE распознавать возвращаемый объект?

Версия IDE 4.0.3.

Заранее благодарен за ответы.

Answer 1

[winbackgo]

у метода getSingleton() надо коммент /** return singleton */

/**
 * @return singleton
 */
public function getSingleton(){

// и даже по цепочке должно работать
/**
 * @return singleton
 */
public static function getInstance() {

Comments

[gaelpa]

Вот же задергает оповещениями хабраюзера return

[Назар Мокринский]

Поддерживаю, это PhpDoc секции, IDE сама помогает их создавать. Рекомендую вставлять их перед каждой функцией/методом.

[return]

можно даже так сделать:

/** @var singleton **/ $object = $system->getSingleton();

но это лучше пользовать в извращенных случаях

[return]

всех обманул :)
я имел в виду вот так:

/** @var singleton $object **/ $object = $system->getSingleton();

[Mikhail Osher]

Попрошу заметить, что документирование — не только для IDE, а еще это признак хорошего тона.

[Павел Зайцев]

Большое спасибо! Теперь понял, как в IDE дела делаются) Раньше документировал код, но так как без IDE — в свободном формате, теперь нужно приучиться к правильному формату.

[Назар Мокринский]

Ещё рекомендую заглянуть на www.phpdoc.org , большую часть указанного там PhpStorm поддерживает

[Павел Зайцев]

Ок, обязательно почитаю!

[gaelpa]

return пришел, ждем var и, на всякий случай, @param

Answer 2

[Fr3nzy]

Простой способ: использовать /** var */, насколько я понимаю.
Т.е. что-то типа

/** @var $system singleton */

Comments

[Павел Зайцев]

Да, действительно работает, спасибо большое! Может кто знает, можно ли сделать автоматическое определение? Чтобы код не разрастался комментариями.

[Павел Зайцев]

Сейчас протестировал, а нельзя ли сделать так, чтобы комментарии типа:
/** var $object singleton */
/** var $object system */

Не дополняли друг друга, а затирали? А то получается смесь методов из двух классов.

[gaelpa]

\var — это запасной метод, на случай если другие тайп-хинты не помогают. По возможности лучше колдовать с \return

Answer 3

[winbackgo]

у метода getSingleton() надо коммент /** return singleton */

/**
 * @return singleton
 */
public function getSingleton(){

// и даже по цепочке должно работать
/**
 * @return singleton
 */
public static function getInstance() {

Comments

[winbackgo]

сорь за повторение, НЛО выдало 500

Answer 4

[Анатолий]

Укажите какого типа переменная котору возвращает ваш метод, в итоде даже в фабрике будет дополнение, при условии что каждая возвращаемая переменная/свойство будет иметь явно указанный тип

/**
 * @var singleton
 */
public static $instance  = null; // Инстанс объекта данного класса

Comments

[Павел Зайцев]

Спасибо!