How can I specify the type of the keys in the documentation of a PHP method that returns an array?
For example, I use this for an array of objects @return MyClass[].
But I want to comment an array like array( 'string' => array( MyClass ) ), is this possible?
Years after the question, it is possible to document array keys and values using, for example, @return array<integer, string> for an array of string values indexed by integer keys.
I do not know to what extent this syntax is standard and well supported. Tools such as PHPCS or Psalm do support it.
You can try to modify the format, it returns an array with special keys(lat, lng) with their types:
@return array{lat: float, lng: float}
Why would you need to specify the datatype. You can just access the values in the array by using a foreach to loop trough the results.
For example:
$arr = array("name" => "MikO", "street" => "straatnaam", "number" => "2");
//Here is key the first key, in this case: name, street, number
//And value are the values of the keys, in this case: MikO, straatnaam, 2
foreach($arr as $key => $value)
{
echo $key." ".$value."<br/>";
}
You can also extract some specific data out of it by using this:
echo $arr['name'];
If you want to go into the object:
foreach($arr as $objname => $objcontent)
{
foreach($objcontent as $objnodename => $objnodevalue)
{
echo $objnodename." = ".$objnodevalue;
}
}
@return MyClass[]to get code completion in PHPStorm and it works perfectly... Why should I not do it? How could I get correct code completion just saying@return array? EDIT: Also, it is in the official PHPDoc site: phpdoc.org/docs/latest/guides/types.html#arrays