让PHPStan明白 Laravel Eloquent Builder query()

Question

我很难让 larastan / phpstan 明白query()应该基于Company model 而不是 Eloquent Eloquent\Model 。 我错过了什么？

<?php

namespace App\Repositories;

use App\Models\Company;

/**
 * @extends AbstractBaseRepository<Company>
 */
class CompanyRepository extends AbstractBaseRepository
{
    public function __construct()
    {
        parent::__construct(new Company());
    }

    public function firstByDomain(string $domain): ?Company
    {
        return $this->query()
            ->where('domain', $domain)
            ->first();
    }
}

<?php

namespace App\Repositories;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

/**
 * @template TModel of Model
 */
abstract class AbstractBaseRepository
{
    /** @var TModel */
    protected $model;

    /** @param TModel $model */
    public function __construct(Model $model)
    {
        $this->model = $model;
    }

    public function query(): Builder
    {
        return $this->model->query();
    }
}

这导致了这个错误：

方法 App\Repositories\CompanyRepository::firstByDomain() 应该返回 App\Models\Company|null 但返回 Illuminate\Database\Eloquent\Model|null。

在我看来，这是由query()方法引起的，为Illuminate\Database\Eloquent\Model返回一个 Eloquent Builder，我认为它应该在这里为App\Models\Company返回一个 Eloquent Builder。

Answer 1

您需要将AbstractBaseRepository中的query方法更改为如下所示：

/** @return Builder<TModel> */
public function query(): Builder
{
    return $this->model->query();
}

因为Builder class 也是通用的。 PHPStan 也不检查函数/方法体。 所以你的返回类型需要准确。