New typed list method for collections

[vaclavekp]

Hi.

I often use chain call of methods ->values()->all() to obtain list of values from Collection. But PhpStan still complains that return type array<int, int> might not be a list. It would be really helpful tu just have method ->list() or ->listAll(), that would just call both of those methods and have correctly typed return value as list<TValue>.

/**
 * @param Collection<array-key, Model>
 * @return list<int>
 */
function extractIds(Collection $models): array
{
    return $models->map(fn (Model $model): int => $model->getId())->values()->all();
}

PhpStan will complain

Method extractIds()  
         should return list<int> but returns array<int, int>.                                                   
         🪪  return.type                                                                                        
         💡 array<int, int> might not be a list. 

Best solution would be:

/**
 * @param Collection<array-key, Model>
 * @return list<int>
 */
function extractIds(Collection $models): array
{
    return $models->map(fn (Model $model): int => $model->getId())->list();
}

[shaedrich]

    return $models->map(fn (Model $model): int => $model->getId())->list();

Wouldn't that be $model->getKey()?

Besides, model IDs aren't always integers. Maybe, this should be generic 🤔

[vaclavekp]

Yes, but thats not the point. I wanted to give simple example. Lets say we have following function

/**
 * @param Collection<array-key, ModelWithIntegerIdentifierInterface>
 * @return list<int>
 */
function extractIds(Collection $models): array
{
    return $models->map(fn (ModelWithIntegerIdentifierInterface $model): int => $model->getId())->values()->all();
}