PHPStorm Code Hinting for array of object arrays

Question

In PHPStorm, the Code Hinting for an object array is simple and awesome;

class FooList {
    public function __construct(){
        $this->_fooList[] = new Foo(1);
        $this->_fooList[] = new Foo(2);
        $this->_fooList[] = new Foo(3);
        $this->_fooList[] = new Foo(4);
    }

    /**
     * @return Foo[]
     */
    getFoos() {
        return $this->_fooList;
    }
}

So if I do...

$fooList = new FooList();

foreach($fooList as $foo)
{
    // Nice hinting.
    $foo->FooMethod...
}

PHPStorm understands that $fooList is an array of Foos, and therefore knows that $foo's type is Foo.

The problem is that I want an array of FooList.

$listOfLists[] = new FooList();
$listOfLists[] = new FooList();
$listOfLists[] = new FooList();
$listOfLists[] = new FooList();

foreach ($listOfLists as $fooList)
{
    foreach($fooList as $foo)
    {
        // No code hinting for $foo :(
    }
}

I know that you can code hint manually inside the foreach, like...

foreach ($listOfLists as $fooList)
{
    foreach($fooList as $foo)
    {
        /** $var $foo Foo */
        // Code hinting, yay!!
    }
}

Or ...

foreach ($listOfLists as $fooList)
{
    /** $var $fooList Foo[] */
    foreach($fooList as $foo)
    {
        // Code hinting, yay!!
    }
}

But I think that is ugly, as $listOfLists is build of Foo arrays, it should know what I am talking about without reminding it every time I implement a listOfLists.

Is there a way to implement this?

Thanks LazyOne! I already Upvoted that issue. If you reply this post with an answer explaining that this issue is actually a requested feature, I'll accept it. — Hector Ordonez
– Hector Ordonez, Commented Dec 18, 2013 at 21:00
This question appears to be off-topic because it is about a feature request in a 3rd party application. — user1592648
– user1592648, Commented Dec 20, 2013 at 4:57
@crypticツ Yeah, but it's also a development tool and therefore on-topic :) — Ja͢ck
– Ja͢ck, Commented Dec 20, 2013 at 5:12
@MrMe: The only reason I said this is off-topic is that is is about a "feature request". The first comment has clearly shown that the feature does not exist and has been requested, and your comment has shown you are asking it to be posted as an answer. If we posted every feature request for every IDE that would be crazy right? This question should be removed as you got your answer in the comment. It's basically like making a post about a bug in some software, which is definitely off-topic. — user1592648
– user1592648, Commented Dec 21, 2013 at 13:38

Community · Accepted Answer · 2017-05-23 12:32:04Z

10

Per the bug report linked in the comments by @LazyOne, as of PhpStorm EAP 138.256 (thus in PHPStorm 8) uniform multi-level array doc parsing is now supported.

This means you can now do this:

/**
 * @var $listOfLists Foo[][]
 */
$listOfLists[] = (new FooList())->getFoos();
$listOfLists[] = (new FooList())->getFoos();
$listOfLists[] = (new FooList())->getFoos();
$listOfLists[] = (new FooList())->getFoos();

foreach ($listOfLists as $fooList)
{
    foreach($fooList as $foo)
    {
        // Code hinting, yay!!
        $foo->fooMethod();
    }
}

and get the expected:

Screenshot

edited May 23, 2017 at 12:32

CommunityBot

11 silver badge

answered Dec 23, 2014 at 7:19

user3942918

26.5k13 gold badges57 silver badges68 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

PHPStorm Code Hinting for array of object arrays

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related