laravel 定义模型的局部查询作用域方法没有PhpStorm没有代码提示

Question

使用 PhpStorm 作为开发编辑器。在 laravel 框架定义模型的局部查询作用域方法 scopeWithOrder()，调用时没有代码提示。
请问怎么才能让 PhpStorm 提示模型定义的局部查询作用域方法？
下面是我的示例代码：
Topic模型

class Topic extends Model
{
    use Illuminate\Database\Eloquent\Factories\HasFactory;
    use Illuminate\Database\Query\Builder;
    /**
     * @param Builder $query
     * @param string $sort
     * @return Builder
     */
    public function scopeWithOrder($query, $sort = 'asc')
    {
        $query->orderBy('updated_at', $sort);
    }
}

Topic控制器

class TopicsController extends Controller
{
    ...
    public function index(Topic $topic, Request $request)
   {
           $topics = $topic->with(['user', 'category'])->withOrder($request->sort)->paginate(8);
        return view('topics.index', compact('topics'));
  }
    ...
}

调用 withOrder 局部查询作用域方法时没有提示，并且调用之后的所有链式方法也都失去了提示，这样开发很是不方便。

Answer 1

不知道你这个问题是否已经解决, 如果还没有解决的话:

• 以下回答来自chatgpt: 解决方案： 要使PhpStorm可以为laravel模型定义的局部查询作用域方法提供代码提示，可以采取以下步骤： 1. 确保在PhpStorm中正确设置了laravel框架的工具支持，可以在“File”菜单中选择“Settings”，然后在“Languages & Frameworks” -> “PHP”下找到“Laravel”选项卡，确保勾选了“Enable”选项，且正确设置了“Path to Laravel”和“Path to php executable”的路径。 2. 在模型类中定义局部查询作用域方法时，需要使用@method注释来声明该方法。例如，对于上述示例中的“withOrder”方法，可以在模型类中添加以下注释： ``` /** * @method static \Illuminate\Database\Eloquent\Builder withOrder($order) */ ``` 其中，@method注释的参数格式为“static 返回类型 方法名称(参数列表)”。 3. 当需要调用局部查询作用域方法时，可以通过模型类的约定方法来实现代码提示。例如，对于示例中的“Post”模型，可以在控制器中使用以下代码来调用withOrder方法并继续添加查询条件： ``` use App\Models\Post; $posts = Post::withOrder('created_at')->where('status', 1)->get(); ``` 在输入“Post::”时，PhpStorm会自动提示可用的方法列表，包括定义的局部查询作用域方法，并提供相应的参数提示。 以上就是如何使PhpStorm对laravel模型定义的局部查询作用域方法进行代码提示的解决方案。希望能对您有所帮助。

如果你已经解决了该问题, 非常希望你能够分享一下解决方案, 写成博客, 将相关链接放在评论区, 以帮助更多的人 ^-^