因此，在PHPDoc中，可以在成员变量声明上方指定@var，以提示其类型。然后一个IDE，例如PHPEd，将知道它正在处理的对象类型，并能够为该变量提供代码洞察力。
<?php
class Test
{
/** @var SomeObj */
private $someObjInstance;
}
?>
这很好，直到我需要对对象数组做同样的事情，以便在以后迭代这些对象时能够得到适当的提示。
那么，是否有一种方法来声明PHPDoc标签，以指定成员变量是SomeObjs的数组?@var数组是不够的，@var数组(SomeObj)似乎是无效的，例如。
当前回答
在JetBrains的PhpStorm IDE中，你可以使用/** @var SomeObj[] */，例如:
/**
* @return SomeObj[]
*/
function getSomeObjects() {...}
phpdoc文档推荐这个方法:
指定包含单个类型时，type定义通知读者每个数组元素的类型。对于给定的数组，只期望有一个Type作为元素。 示例:@return int[]
其他回答
指定一个变量是一个对象数组:
$needles = getAllNeedles();
/* @var $needles Needle[] */
$needles[1]->... //codehinting works
这在Netbeans 7.2中工作(我正在使用它)
还与:
$needles = getAllNeedles();
/* @var $needles Needle[] */
foreach ($needles as $needle) {
$needle->... //codehinting works
}
因此，在foreach中使用声明是不必要的。
Use:
/* @var $objs Test[] */
foreach ($objs as $obj) {
// Typehinting will occur after typing $obj->
}
在输入内联变量时，和
class A {
/** @var Test[] */
private $items;
}
类属性。
2009年PHPDoc(以及像Zend Studio和Netbeans这样的ide)没有这个选项时的先前答案:
你最多只能说，
foreach ($Objs as $Obj)
{
/* @var $Obj Test */
// You should be able to get hinting after the preceding line if you type $Obj->
}
我在Zend Studio经常这样做。我不知道其他编辑器的情况，但它应该能起作用。
如果你使用PHPStorm 2021.2+，你也可以使用这个语法(数组形状):
@property array{name: string, content: string}[] $files
or
@var array{name: string, content: string}[] $files
Netbeans提示:
在$users[0]->和$this->的User类数组上实现代码完成。
/**
* @var User[]
*/
var $users = array();
当你完成$this->…，你还可以在类成员列表中看到数组的类型。
正如DanielaWaranie在她的回答中提到的——当你在$collectionObject中迭代$items时，有一种方法可以指定$item的类型:将@return MyEntitiesClassName添加到current()以及返回值的Iterator和arrayaccess方法的其余部分。
繁荣!不需要在/** @var SomeObj[] $collectionObj */ over foreach中，与收集对象一起工作，不需要使用特定的方法@return SomeObj[]返回收集。
我怀疑不是所有的IDE都支持它，但它在PhpStorm中工作得很好，这让我更高兴。
例子:
class MyCollection implements Countable, Iterator, ArrayAccess {
/**
* @return User
*/
public function current() {
return $this->items[$this->cursor];
}
//... implement rest of the required `interface` methods and your custom
}
有什么有用的我要添加张贴这个答案
在我的情况下，current()和其余的接口方法是在抽象集合类中实现的，我不知道什么样的实体最终将存储在集合中。
这里有一个技巧:不要在抽象类中指定返回类型，而是在特定的集合类的描述中使用PhpDoc指令@method。
例子:
class User {
function printLogin() {
echo $this->login;
}
}
abstract class MyCollection implements Countable, Iterator, ArrayAccess {
protected $items = [];
public function current() {
return $this->items[$this->cursor];
}
//... implement rest of the required `interface` methods and your custom
//... abstract methods which will be shared among child-classes
}
/**
* @method User current()
* ...rest of methods (for ArrayAccess) if needed
*/
class UserCollection extends MyCollection {
function add(User $user) {
$this->items[] = $user;
}
// User collection specific methods...
}
现在，类的使用:
$collection = new UserCollection();
$collection->add(new User(1));
$collection->add(new User(2));
$collection->add(new User(3));
foreach ($collection as $user) {
// IDE should `recognize` method `printLogin()` here!
$user->printLogin();
}
再说一次:我怀疑不是所有的IDE都支持它，但是PhpStorm支持。试试你的，在结果中发表评论!
