Feature: Eloquent Builder Types
Illuminate\Database\Eloquent\Builder has type support
Background:
Given I have the following config
"""
"""
Scenario: Models can call eloquent query builder instance methods
Given I have the following code
"""
*/
public function getNewQuery(): \Illuminate\Database\Eloquent\Builder
{
return User::query();
}
/**
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getNewModelQuery(): \Illuminate\Database\Eloquent\Builder
{
return (new User())->newModelQuery();
}
/**
* @param \Illuminate\Database\Eloquent\Builder $builder
*/
public function firstOrFailFromBuilderInstance(\Illuminate\Database\Eloquent\Builder $builder): User {
return $builder->firstOrFail();
}
/**
* @param \Illuminate\Database\Eloquent\Builder $builder
*/
public function findOrFailFromBuilderInstance(\Illuminate\Database\Eloquent\Builder $builder): User {
return $builder->findOrFail(1);
}
/**
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return \Illuminate\Database\Eloquent\Collection
*/
public function findMultipleOrFailFromBuilderInstance(\Illuminate\Database\Eloquent\Builder $builder): \Illuminate\Database\Eloquent\Collection {
return $builder->findOrFail([1, 2]);
}
/**
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getWhereBuilderViaInstance(array $attributes): \Illuminate\Database\Eloquent\Builder {
return (new User())->where($attributes);
}
}
"""
When I run Psalm
Then I see no errors
Scenario: can call static methods on model
Given I have the following code
"""
*/
public function getWhereBuilderViaStatic(array $attributes): \Illuminate\Database\Eloquent\Builder
{
return User::where($attributes);
}
/**
* @psalm-return \Illuminate\Database\Eloquent\Collection
*/
public function getWhereViaStatic(array $attributes): \Illuminate\Database\Eloquent\Collection
{
return User::where($attributes)->get();
}
}
"""
When I run Psalm
Then I see no errors
Scenario:
Given I have the following code
"""
*/
public function test_failure(): \Illuminate\Database\Eloquent\Builder
{
return User::fakeQueryMethodThatDoesntExist();
}
}
"""
When I run Psalm
Then I see these errors
| MixedInferredReturnType | Could not verify return type 'Illuminate\Database\Eloquent\Builder' for UserRepository::test_failure |
| MixedReturnStatement | Could not infer a return type |