[ArrayShape] doesn't work for structure inside the array

[hantc]

Hello, pseudocode:

    #[ArrayShape(['soldCount' => 'int', 'bookId' => 'int'])]
    public function foo(): array
    {
        $arr = [];

        $arr[] = [
            'soldCount' => 123,
            'bookId' => 453478,
        ];

        $arr[] = [
            'soldCount' => 22,
            'bookId' => 7863,
        ];


        return $arr;
    }

I'm not able to make phpstorm to suggest 'soldCount' and 'bookId' inside foreach. Is there any way how to define ArrayShape for structure inside list of items in array?

foreach ($this->foo() as $item) {
   echo $item['soldCount']; // phpstorm doesn't suggest
}

[jonnywilliamson]

Actually a bit freaky as I was coming here to report very similar issue and you've posted only 25mins before me.

The issue is with regards having an array with just keys => values vs having an array that contains OTHER arrays with keys => values.

Take this code, it shows an single array being returned with only keys=>values. Everything works:

#[ArrayShape(
    [
        'id'   => 'int',
        'name' => 'string',
        'foo'  => Exception::class,
    ])]
function users(): array
{
    return [
        'id'   => 3,
        'name' => 'Harry',
        'foo'  => InvalidArgumentException::class,
    ];
}

$users = users();
$users['foo']-><CURSOR>;

In PHPStorm we get autocomplete:

But what should we do if we return a collection of arrays (an array containing many arrays)? How do we use Arrayshape to say every single item in this array, is an array with a shape like this?

Here was my attempt:

#[ArrayShape(
    [
        [
            'id'   => 'int',
            'name' => 'string',
            'foo'  => Exception::class,
        ],
    ]
)]
function users(): array
{
    return [
        [
            'id'   => 1,
            'name' => 'Tom',
            'foo'  => Exception::class,
        ],
        [
            'id'   => 2,
            'name' => 'Dick',
            'foo'  => Exception::class,
        ],
    ];
}

$users = users();
$users['<CURSOR>']

But no joy at all in PHPStorm.

Is this even possible?

[wbars]

Hello, thank you for the suggestion. Nested arrays without keys are not supported at this point. We created a feature request to follow: https://youtrack.jetbrains.com/issue/WI-65168