Code hinting method properties in PhpStorm

Question

Suppose I have the following class:

namespace Acme\SuperBundle\Resources;
use \DOMDocument;
/**
* Class XMLAnswerParser
* @package Acme\SuperBundle\Resources
* @author Quant
* @param \DOMDocument $dom
*/
class XMLAnswerParser
{

public $dom;
private $profile;

// a whole lot of things

protected function checkDOM()
{
    $this->dom->

And I'd expect any IDE to give me hinting knowing that the $dom property is a DOMDocument. Somehow this is not working in my IDE phpstorm. Am I doing something wrong with the documentation of the class?

The code contains no errors, in case you'd ask that.

You don't have any `@var` docblock entry for the dom property... you have an `@param` stuck in the class-level docblock — Mark Baker, May 15 '13 at 17:45
You should have an `@var` entry in a docblock for each individual property; and `@param` should appear in method docblocks, not in class docblocks — Mark Baker, May 15 '13 at 17:49

score 4 · Answer 1 · answered May 15 '13 at 17:50

4

<?php
/**
* @var DOMDocument $dom
*/
public $dom
?>

Was the way to do it!

answered May 15 '13 at 17:50

Quant

350
3
14

and don't forget the relevant use for the object. – Jean-Christophe Meillaud Jul 24 '13 at 11:51

score 1 · Answer 2 · answered Aug 05 '15 at 11:03

Add

namespace Acme\SuperBundle\Resources;
use \DOMDocument;
/**
 * Class XMLAnswerParser
 * @package Acme\SuperBundle\Resources
 * @author Quant
 */
class XMLAnswerParser
{

/**
 * @var \DOMDocument $dom
 */
public $dom;

private $profile;

// a whole lot of things

protected function checkDOM()
{
    $this->dom->

Then the IDE will know what $dom exatctly is.

score 0 · Answer 3 · answered Apr 17 '15 at 10:02

0

@param \DOMDocument $dom --> @property \DOMDocument $dom

answered Apr 17 '15 at 10:02

hovszabolcs

101
1
2

Code hinting method properties in PhpStorm

3 Answers3