bigmom/point

点管理包。

dev-master 2021-08-05 06:43 UTC

This package is auto-updated.

Last update: 2024-09-05 13:57:29 UTC


README

警告

  • 此包尚未成熟。请勿在生产环境中安装。此包中可能存在错误和性能问题。

Point的主要功能:增加点数,获取点数。但首先,您需要设置点模板和标签。

标签对点模板施加限制。点模板有两种类型:永久和今日。这些类型指的是这些点模板应用限制的方式。

安装

composer require bigmom/point php artisan vendor:publish php artisan migrate

如果 bigmom/auth 尚未发布,请进行发布。

用法

管理

通过 /bigmom 登录。在添加或检索点数之前,请先创建点模板。

添加点数

Bigmom\Point\Facades\AddPoint

点数可以同步或队列添加。这可以在配置中设置,也可以在方法本身中设置。

add() 参数

  • ownerId = 必需的字符串。
  • template = 必需的字符串/整数。将通过查找id解析模板。如果不存在,将通过模板主题查找。
  • value = 可选的整数。要添加的点数值。默认为 1
  • shouldQueue = 可选的布尔值。默认 config('point.add.queue')。如果为false,添加点数将在同步中运行。否则,使用队列。

addSync()add($ownerId, $template, $value, false) 的便捷方法。参数

  • ownerId = 必需的字符串。
  • template = 必需的字符串/整数。将通过查找id解析模板。如果不存在,将通过模板主题查找。
  • value = 可选的整数。要添加的点数值。默认为 1

addAsync()add($ownerId, $template, $value, true) 的便捷方法。参数

  • ownerId = 必需的字符串。
  • template = 必需的字符串/整数。将通过查找id解析模板。如果不存在,将通过模板主题查找。
  • value = 可选的整数。要添加的点数值。默认为 1

获取点数

Bigmom\Point\Facades\GetPoint

获取点数。使用构建器模式。例如 GetPoint::owner($ownerId)->subject($subject)->today()->get();

  • owner($ownerId) - 设置查询的所有者ID。
  • subject($subject) - 设置点模板主题进行查询。
  • from($from) - 仅查询此时间戳。
  • until($until) - 仅查询到此时间戳。
  • date($date) - 查询特定日期创建的记录的便捷方法。
  • today() - 查询今天的记录的便捷方法。
  • tags($tags) - 仅查询具有给定标签的点模板。必须是数组或数组形式字符串。
  • compact() - 不返回点模型,仅返回总点数、限制点数和记录数。
  • get() - 最后使用。返回总点数、限制点数、记录数和点模型,如果未设置 compact()。