logo 有点东西

hyperf 模型的软删除功能在IDE内没有代码提示的问题与解决

如图所示，withTrashed方法没有代码提示。

关于软删除的部分，可以参考laravel的文档：传送门，主要影响了trashed、restore、withTrashed、withoutTrashed、onlyTrashed这5个方法。

withTrashed、withoutTrashed、onlyTrashed的代码提示

在对应的Model里添加下面的phpDoc方法注释来解决：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?php

namespace App\Model;

use Hyperf\Database\Model\SoftDeletes;

/**
 * @method  \Hyperf\Database\Model\Builder withTrashed()
 * @method  \Hyperf\Database\Model\Builder withoutTrashed()
 * @method  \Hyperf\Database\Model\Builder onlyTrashed()
 */

class Test extends Model
{
    ...
}

2021.4.1更新 trashed、restore的代码提示

发现phpDoc有个@mixin，可以直接把对应类的方法添加到当前类的代码提示中，现在改为：

对应模型类中增加@mixin SoftDeletes注释

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?php

namespace App\Model;

use Hyperf\Database\Model\SoftDeletes;

/**
 * @mixin SoftDeletes
 * @method  \Hyperf\Database\Model\Builder withTrashed()
 * @method  \Hyperf\Database\Model\Builder withoutTrashed()
 * @method  \Hyperf\Database\Model\Builder onlyTrashed()
 */

class Test extends Model
{
    use SoftDeletes;

    其他代码...
}

在使用的位置用@var注释

1
2
3
4
5
6
7
8
9
10
11
<?php

/**
 * 【关键步骤】靠这一句来获取代码提示
 * @var $test Test
 */
$test = Test::withTrashed()->find(1);

if ($test->trashed()) {
    $test->restore();
}

终于解决啦，还是对phpDoc不熟啊。

hyperf 模型的软删除功能在IDE内没有代码提示的问题与解决

作者：有点东西

链接： https://www.youdiandongxi.com/article/hyperf-SoftDeletes.html

协议：本文采用 CC BY-NC-SA 4.0 隐私协议，转载请注明出处！

上一篇：《net::ERR_UNSAFE_PORT的问题》 下一篇：《微信X5同层播放遮挡自定义按钮的BUG》

其他推荐内容

使用Nuxt升级改造Excel理财记账本
  • 2025/05/09
    • 编程

使用Nuxt升级改造Excel理财记账本

h5处理emoji提交
  • 2018/07/09
    • 编程

h5处理emoji提交

HyperF中Redis::OPT_SERIALIZER的取值和区别
  • 2021/03/29
    • 编程

HyperF中Redis::OPT_SERIALIZER的取值和区别

评论区