PHPDoc类型提示数组对象?

我知道我来晚了，但我最近一直在研究这个问题。我希望有人能看到这一点，因为公认的答案虽然是正确的，但并不是最好的方法。至少在PHPStorm中没有，不过我还没有测试NetBeans。

最好的方法是扩展ArrayIterator类，而不是使用本机数组类型。这允许你在类级别而不是实例级别输入提示，这意味着你只需要PHPDoc一次，而不是贯穿你的代码(这不仅是混乱的，违反了DRY，但也可能是有问题的，当涉及到重构时PHPStorm有一个重构时丢失PHPDoc的习惯)

参见下面的代码:

class MyObj
{
    private $val;
    public function __construct($val) { $this->val = $val; }
    public function getter() { return $this->val; }
}

/**
 * @method MyObj current()
 */
class MyObjCollection extends ArrayIterator
{
    public function __construct(Array $array = [])
    {
        foreach($array as $object)
        {
            if(!is_a($object, MyObj::class))
            {
                throw new Exception('Invalid object passed to ' . __METHOD__ . ', expected type ' . MyObj::class);
            }
        }
        parent::__construct($array);
    }

    public function echoContents()
    {
        foreach($this as $key => $myObj)
        {
            echo $key . ': ' . $myObj->getter() . '<br>';
        }
    }
}

$myObjCollection = new MyObjCollection([
    new MyObj(1),
    new MyObj('foo'),
    new MyObj('blah'),
    new MyObj(23),
    new MyObj(array())
]);

$myObjCollection->echoContents();

这里的关键是PHPDoc @method MyObj current()覆盖从ArrayIterator继承的返回类型(它是混合的)。这个PHPDoc的包含意味着当我们使用foreach($this as $myObj)遍历类属性时，当引用变量$myObj->…

对我来说，这是实现这一点的最利落的方法(至少在PHP引入类型化数组之前是这样，如果它们曾经这样做过的话)，因为我们是在可迭代类中声明迭代器类型，而不是在分散在整个代码中的类实例上声明迭代器类型。

我没有在这里展示扩展ArrayIterator的完整解决方案，所以如果你使用这种技术，你可能还想:

根据需要包括其他类级PHPDoc，例如offsetGet($index)和next() 将完整性检查is_a($object, MyObj::class)从构造函数移到私有方法中从offsetSet($index， $newval)和appappvalue ($value)等方法重写调用这个(现在是私有的)健全检查

2016-12-23 00:21:18

在JetBrains的PhpStorm IDE中，你可以使用/** @var SomeObj[] */，例如:

/**
 * @return SomeObj[]
 */
function getSomeObjects() {...}

phpdoc文档推荐这个方法:

指定包含单个类型时，type定义通知读者每个数组元素的类型。对于给定的数组，只期望有一个Type作为元素。示例:@return int[]

2009-11-19 13:50:37

我发现了一些有用的东西，它可以拯救生命!

private $userList = array();
$userList = User::fetchAll(); // now $userList is an array of User objects
foreach ($userList as $user) {
   $user instanceof User;
   echo $user->getName();
}

2010-01-13 10:43:15

在Zend Studio中使用数组[type]。

在Zend Studio中，数组[MyClass]或数组[int]甚至数组[array[MyClass]]都可以很好地工作。

2014-04-14 23:18:31

在NetBeans 7.0(可能更低)中，你可以声明返回类型为“数组与文本对象”，就像@return Text和代码提示一样:

编辑:用@Bob Fanger的建议更新了示例

/**
 * get all Tests
 *
 * @return Test|Array $tests
 */
public function getAllTexts(){
    return array(new Test(), new Test());
}

使用它:

$tests =  $controller->getAllTests();
//$tests->         //codehinting works!
//$tests[0]->      //codehinting works!

foreach($tests as $text){
    //$test->      //codehinting works!
}

这并不完美，但总比“混合”要好，因为“混合”没有任何价值。

缺点是你可以将数组作为文本对象，这会抛出错误。

2013-02-06 14:01:12