当返回类型被错误推断时，如何防止 PhpStorm 中的错误警告？

Question

考虑以下代码：

<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
/**
 * Class MyModel
 * @package App\Models
 * @mixin Builder
 */
class MyModel extends Model
{
    public static function getGreens(): Builder
    {
        return (new self())->where('color', '=', 'green');
    }
}

在return 声明中，PhpStorm (2020.3) 抱怨说：

返回值预计为'\Illuminate\Database\Eloquent\Builder'，返回'MyModel'

并建议：

将返回类型从 '\Illuminate\Database\Eloquent\Builder' 更改为 'MyModel'

这是非常不正确的（where 方法确实返回了 \Illuminate\Database\Eloquent\Builder 的实例，而 IDE 将返回类型推断为 MyModel 类型）。通过删除返回类型，IDE 发出另一个警告：

缺少函数的返回类型声明

代码可以正常运行，但 IDE 不应报告任何 false 警告！我应该如何避免在 PhpStorm 中出现这些警告？

Answer 1

这是未遵循“最佳做法”的结果。 MyModel 的类层次结构没有提供where 的方法；换句话说，这样的方法在类层次结构中不存在。但！ Model 的父类确实提供了 __call() 的 magic method，当调用对象上下文中的 无法访问的方法（在您的情况下为 where 的方法）时，它会被触发。它本质上是forwards the "call" 到\Illuminate\Database\Eloquent\Builder 的一个新实例，它具有所请求方法的实现（它是通过调用newQuery() 的方法获得的）。这种机制不仅对IDE不友好，而且slower。

因此；删除@mixin 标签，而不是使用“魔术方法”，使用“本机访问”：

<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;

class MyModel extends Model
{
    public static function getGreens(): Builder
    {
        return (new self())->newQuery()->where('color', '=', 'green');
        //                 ^^^^^^^^^^^^
    }
}

Answer 2

据我了解（基于 ​​Laravel 的工作方式）这是因为 @mixin 行。

@mixin 标签的工作方式类似于 PHP 的原生 trait 工作方式。因此，如果您有一个返回 $this / self 的特征中的方法，然后在类中使用该特征，则该方法的返回 ($this/self) 指向使用它的类。

现在，Builder::where() 方法也返回 $this 或 self ... 但它实际上并不是一个 trait，但 Laravel 神奇地使 where() 方法在这个类中可用。

问题来了：@return $this 实际上指向 Builder 类，但是当“作为特征”使用时（因为 @mixin）它被 IDE 解析为当前的 MyModel 类。

---

您可以使用 @mixin 并忽略该问题（您可以通过 Alt + Enter 快速修复菜单使用错误抑制 - 它会为 IDE 添加注释以告知忽略该特定问题在此处发布）.. 或删除 @mixin 并以不同方式声明这些方法。

AFAIK Laravel helper package 应该通过 @method PHPDoc 行将所有此类 Builder 方法添加到 Model 类（查看详细信息，查看过去的问题以了解它如何以及为什么这样做等，例如 @987654323 @)。

另一个建议：试试Laravel Idea plugin——它是一个付费插件，但它使使用 Laravel 代码更容易，而且 AFAIK 它应该涵盖这些基本内容。

---

供参考：

• https://youtrack.jetbrains.com/issue/WI-1730 -- 记录/支持 mixins 的原始请求
• 优秀的@mixin 可以在此处关联的票证（至少部分关联）：
  • https://youtrack.jetbrains.com/issue/WI-34809
  • https://youtrack.jetbrains.com/issue/WI-49567
  • 或尝试您自己的搜索，例如https://youtrack.jetbrains.com/issues/WI?q=mixin%20laravel