PHPStorm: method xpath not found in class. Как «научить» IDE находить методы?

Question

[Arris]

Словами я замучаюсь объяснять, я лучше гифку покажу:



Простой класс-обёртка. При выборе метода для $this-svg возможные методы в списке подставляются, а потом метод сразу подсвечивается как not found.

Что интересно, такое поведение имеет место быть не всегда! Например, для обёртки над PDO иногда все нормально, иногда method prepare() not found in class.

Пытался гуглить, но сформулировать запрос так и не смог.

WTF? ЧЯДНТ?

Comments

[Arris]

Что интересно, если прямо в конструкторе написать
$this->svg->xpath
- никакой жёлтой подсветки нет. Такое впечатление, что IDE "забывает" про принадлежность переменной или не хочет её анализировать за пределы функции.

Такое поведение... нервирует, скажем так.

Answer 1

[Arman]

А если указать php-doc?

class ParseSVG {
    /**
     * @var SimpleXMLElement
     */
    private $svg;
}

Comments

[Arris]

Я думал про это. Сейчас попробую.

Что интересно - через некоторое произвольное время (иногда 15 секунд, иногда минута, иногда после переоткрытия проекта) IDE очухивается и убирает жёлтую подсветку. Но я что-то не верю, что она так долго анализирует "проект" из пяти файлов.

[Arris]

Что интересно, после того, как IDE "очухивается" - оно автоматом по дополнению /**Enter генерирует строго такой PHPDoc, как вы написали:

/**
     * @var SimpleXMLElement
     */
    private $svg;

Вероятно ваш ответ можно считать решением, но я еще подожду мнений, лады?

[Arman]

Arris: может проблемы с диском? сторонних библиотек нет? почему так долго файлы парсит? может что в настройках указали или кучу плагинов? если подключаете что через композер, то лучше эту папку в игнор и подключить через External Libraries

[Arris]

Arik: нет, единственная "проблема с диском" - это то, что проект лежит на сетевой шаре (самба). Но - 100мегабитная локалка.. сами понимаете, приемлемо все со скоростью.

В настройках вроде бы (по крайней мере те изменения, которые я вносил, точно не относятся к задаче) все стандартно. Композер не использую, в нем нет необходимости... и вообще, там фреймворка-то толком нет, в проекте десяток файлов, связанных статично (то есть без магии типа аутолоадера).

[Arman]

Arris: если как эксперимент забрать все файлы и положить к себе на диск?

[Arris]

Arik: вот еще более сложный момент, который PHPDoc'ом не решается:

Если делать без класса:

$all_paths_at_layer = $svg->xpath('//svg:g[starts-with(@inkscape:label, "Paths")]/svg:path');

foreach ($all_paths_at_layer as $path) {

    $path_d     = (string)$path->attributes()->{'d'};
    $path_id    = (string)$path->attributes()->{'id'};
    $path_style = (string)$path->attributes()->{'style'};
}

Никакой подсветки жёлтым нет, $path нормально интерпретируется как возможный контейнер для XML

Заворачиваем в класс:

public function parse($paths_layers_name , $images_layer_name)
    {
        $this->layer_paths  = $this->svg->xpath( '//svg:g[starts-with(@inkscape:label, "Paths")]' );
        $this->layer_images = $this->svg->xpath(  '//svg:g[starts-with(@inkscape:label, "Images")]/svg:image' );
    }

public function getPathsDefinition()
    {
        foreach ($this->layer_paths as $path) {

            $path_d     = (string)$path->attributes()->{'d'};
            $path_id    = (string)$path->attributes()->{'id'};
            $path_style = (string)$path->attributes()->{'style'};
       ... 
      }
}

И всё, внутри функции getPathsDefinition $path уже не просто "жёлтенькое", а даже подстановку методов не даёт.

Поневоле думаю - а нахрена я это в класс заворачиваю? Может функцией обойтись?

[Arman]

Arris: Опять же PHP-doc. IDE анализирует код, а не выполняет. Т.е. нет явного назначения этих свойств, поэтому IDE вас не запутывает, может туда что другой положите, а потом будете материть его чего он чужие методы показывает =) поэтому php-doc'ом вы подсказываете что за свойство у вас. Или можно свойства сначала сделать в переменную и перед ней опять же указать var SimpleXMLElement

[Arris]

Arik: вы знаете, интересный результат.

Во-первых: перемещение проекта на локальный диск (SSD) не влияет совершенно - IDE точно так же "не прочухивает" мгновенно происходящее (хотя, возможно, сокращается время прочухивания)
Во-вторых, декларация PHPDoc заставляет IDE прочухаться мгновенно, вне зависимости от того, где мы - на диске сетевом или локальном (конечно пришлось создать новый файл с новым классом, чтобы определить этот факт, потому что тот класс походу уже в "кэше инспекций")

Осталось понять, как написать сложный PHPDoc для элементов, которые динамически подставляются в массив, а потом оттуда изымымаются.

Как вообще написать PHPDoc для описания элементов внутри массива?

[Arman]

Arris: вы про @var SimpleXMLElement[]?

[Arris]

Arik: нет, смотрите:

$this->layer_paths  = $this->svg->xpath( '//svg:g[starts-with(@inkscape:label, "Paths")]'

// где-то в другом месте:
foreach ($this->layer_paths as $path) {
            $path_d     = (string)$path->attributes()->{'d'};
}

Как сказать IDE, что $path это SimpleXMLElement или что $this->layer_paths является массивом, содержащим такие элементы?

[Arman]

IDE должен смотреть на свойство layer_paths, там точно указали PHP-doc? надо указать SimpleXMLElement[], квадратные скобки говорят что это массив. Если совсем никак не хочет понимать, то можно до работы с $path указать php-doc в цикле * $path SimpleXMLElement

[Arris]

Arik: спасибо. Вечером отмечу ваш ответ как решение.