laravel/framework

View on GitHub
types/Database/Eloquent/Collection.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

use function PHPStan\Testing\assertType;

$collection = User::all();
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection);

assertType('Illuminate\Database\Eloquent\Collection<int, User>|User|null', $collection->find(1));
assertType('Illuminate\Database\Eloquent\Collection<int, User>|string|User', $collection->find(1, 'string'));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->load('string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->load(['string']));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->load(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}]));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadAggregate('string', 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadAggregate(['string'], 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadAggregate(['string'], 'string', 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadAggregate(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}], 'string', 'string'));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadCount('string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadCount(['string']));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadCount(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}]));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMax('string', 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMax(['string'], 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMax(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}], 'string'));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMin('string', 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMin(['string'], 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMin(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}], 'string'));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadSum('string', 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadSum(['string'], 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadSum(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}], 'string'));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadAvg('string', 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadAvg(['string'], 'string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadAvg(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}], 'string'));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadExists('string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadExists(['string']));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadExists(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}]));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMissing('string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMissing(['string']));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMissing(['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}]));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMorph('string', ['string']));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMorph('string', ['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}]));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMorphCount('string', ['string']));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->loadMorphCount('string', ['string' => function ($query) {
    // assertType('\Illuminate\Database\Query\Builder', $query);
}]));

assertType('bool', $collection->contains(function ($user) {
    assertType('User', $user);

    return true;
}));
assertType('bool', $collection->contains('string', '=', 'string'));

assertType('array<int, (int|string)>', $collection->modelKeys());

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->merge($collection));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->merge([new User]));

assertType(
    'Illuminate\Support\Collection<int, User>',
    $collection->map(function ($user, $int) {
        assertType('User', $user);
        assertType('int', $int);

        return new User;
    })
);

assertType(
    'Illuminate\Support\Collection<int, User>',
    $collection->mapWithKeys(function ($user, $int) {
        assertType('User', $user);
        assertType('int', $int);

        return [new User];
    })
);
assertType(
    'Illuminate\Support\Collection<string, User>',
    $collection->mapWithKeys(function ($user, $int) {
        return ['string' => new User];
    })
);

assertType(
    'Illuminate\Database\Eloquent\Collection<int, User>',
    $collection->fresh()
);
assertType(
    'Illuminate\Database\Eloquent\Collection<int, User>',
    $collection->fresh('string')
);
assertType(
    'Illuminate\Database\Eloquent\Collection<int, User>',
    $collection->fresh(['string'])
);

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->diff($collection));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->diff([new User]));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->intersect($collection));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->intersect([new User]));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->unique());
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->unique(function ($user, $int) {
    assertType('User', $user);
    assertType('int', $int);

    return $user->getTable();
}));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->unique('string'));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->only(null));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->only(['string']));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->except(null));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->except(['string']));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->makeHidden('string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->makeHidden(['string']));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->makeVisible('string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->makeVisible(['string']));

assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->append('string'));
assertType('Illuminate\Database\Eloquent\Collection<int, User>', $collection->append(['string']));

assertType('array<User>', $collection->getDictionary());
assertType('array<User>', $collection->getDictionary($collection));
assertType('array<User>', $collection->getDictionary([new User]));

assertType('Illuminate\Support\Collection<(int|string), mixed>', $collection->pluck('string'));
assertType('Illuminate\Support\Collection<(int|string), mixed>', $collection->pluck(['string']));

assertType('Illuminate\Support\Collection<int, int>', $collection->keys());

assertType('Illuminate\Support\Collection<int, Illuminate\Support\Collection<int, int|User>>', $collection->zip([1]));
assertType('Illuminate\Support\Collection<int, Illuminate\Support\Collection<int, string|User>>', $collection->zip(['string']));

assertType('Illuminate\Support\Collection<int, mixed>', $collection->collapse());

assertType('Illuminate\Support\Collection<int, mixed>', $collection->flatten());
assertType('Illuminate\Support\Collection<int, mixed>', $collection->flatten(4));

assertType('Illuminate\Support\Collection<User, int>', $collection->flip());

assertType('Illuminate\Support\Collection<int, int|User>', $collection->pad(2, 0));
assertType('Illuminate\Support\Collection<int, string|User>', $collection->pad(2, 'string'));

assertType('array<int, mixed>', $collection->getQueueableIds());

assertType('array<int, string>', $collection->getQueueableRelations());