Ferid Movsumov Ferid Movsumov - 20 days ago 7
PHP Question

How can I specify array of objects in PhpDoc


Possible Duplicate:

PHPDoc type hinting for array of objects?




I use PhpDocumentor2 for generating documentation.
I searched for this subject but I can't find specific rule for it.
For Example I have class which name is AddressField and I want to specify my $addressFields as array of AddressField objects.

/**
* @var AddressField[]
*/
private $addressFields;

Answer

phpdoc themselves describe the use of arrays here:

1.4.4. Arrays

  • undefined: @return array
  • single type: @return int[]
  • multi type: @return (int|string)[]

The same should apply to variable definitions:

/* @var $arr Type[] */