CRMEB/backend/modules/service/mcp/tools/CouponUsageStatisticsTool.php
sugar1569 3b5bd37bfb feat(mcp): 为内置工具添加分类方法并优化订单列表搜索逻辑
为所有 MCP 内置工具实现 category() 分类方法,支持管理后台按业务分组展示;优化订单列表关键词搜索逻辑,使用闭包显式 OR 条件匹配订单号和商品标题,避免管道字段静默丢弃问题;新增优惠券库存调整原子方法,提升并发安全性;同步更新相关文档和注释,完善分类展示规则说明。
2026-09-24 11:57:27 +08:00

109 lines
3.9 KiB
PHP
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
declare(strict_types=1);
namespace modules\service\mcp\tools;
use app\dao\activity\coupon\StoreCouponIssueDao;
use app\dao\activity\coupon\StoreCouponUserDao;
use modules\service\mcp\CouponIssueCriteria;
use modules\service\mcp\McpException;
use crmeb\interfaces\McpToolInterface;
use modules\service\mcp\ReportPeriod;
/** MCP 工具:按使用时间统计用户券的已使用状态。 */
class CouponUsageStatisticsTool implements McpToolInterface
{
/** @var StoreCouponUserDao 用户券 DAO */
private StoreCouponUserDao $userCouponDao;
/** @var StoreCouponIssueDao 发行配置 DAO */
private StoreCouponIssueDao $issueDao;
/**
* @param StoreCouponUserDao $userCouponDao 用户券 DAO
* @param StoreCouponIssueDao $issueDao 发行配置 DAO
*/
public function __construct(StoreCouponUserDao $userCouponDao, StoreCouponIssueDao $issueDao)
{
$this->userCouponDao = $userCouponDao;
$this->issueDao = $issueDao;
}
/** @return string MCP 工具名称 */
public function name(): string
{
return 'crmeb_coupon_usage_statistics';
}
/** @return string 工具描述与使用统计口径 */
public function description(): string
{
return '按用户券 use_time 统计全站或指定发行配置在日期范围内已使用的券张数、使用人数与券面额合计,默认近 7 天。'
. '只计截至目前仍为已使用状态的券;退款后恢复的券不计入,不能当作历史使用事件总数。'
. '券面额合计不是订单实际抵扣金额或财务成本。';
}
/**
* 工具中文名(管理后台展示)
* @return string
*/
public function label(): string
{
return '用券统计';
}
/** @return string 工具分类(管理后台分组展示) */
public function category(): string
{
return '营销';
}
/** @return array MCP 入参 JSON Schema */
public function inputSchema(): array
{
return [
'type' => 'object',
'properties' => [
'issue_id' => ['type' => 'integer', 'minimum' => 1, 'description' => '优惠券发行配置 ID;不传统计全站'],
'start_date' => ['type' => 'string', 'format' => 'date', 'description' => '开始日期 YYYY-MM-DD,与 end_date 同时提供;默认近 7 天'],
'end_date' => ['type' => 'string', 'format' => 'date', 'description' => '结束日期 YYYY-MM-DD,包含结束日;最多 31 天'],
],
];
}
/**
* @param array $args 可选发行配置 ID 与使用日期范围
* @return array 优惠券使用情况统计
* @throws McpException 参数错误或发行记录不存在
*/
public function execute(array $args): array
{
$period = ReportPeriod::fromArgs($args, '优惠券使用统计');
$issueId = CouponIssueCriteria::issueId($args, $this->issueDao);
$query = $this->userCouponDao->search()->where('cid', '>', 0)
->where('status', 1)
->whereBetween('use_time', [$period['start_time'], $period['end_time']]);
if ($issueId !== null) {
$query->where('cid', $issueId);
}
$result = $query->field([
'COUNT(id) AS used_coupons',
'COUNT(DISTINCT CASE WHEN uid>0 THEN uid END) AS unique_users',
'COALESCE(SUM(coupon_price),0) AS face_value_total',
])->find();
$row = $result ? $result->toArray() : [];
return [
'issue_id' => $issueId,
'start_date' => $period['start_date'],
'end_date' => $period['end_date'],
'metrics' => [
'used_coupons' => (int)($row['used_coupons'] ?? 0),
'unique_users' => (int)($row['unique_users'] ?? 0),
'face_value_total' => (string)($row['face_value_total'] ?? '0.00'),
],
];
}
}