Skip to content
Intally

快速开始

快速开始

WHMCS DataGen 是 WHMCS 开发环境的测试数据生成器：一键生成真实客户 / 产品 / 订单 / 发票 / 工单，每个批次都可独立清理回滚。本指南覆盖安装、第一次生成、清理。

专为开发/测试环境：生产环境不要安装。所有数据写入真实 WHMCS 表，但都标记 batch_id 便于回滚。

1. 安装与启用

  1. 下载与 PHP 版本匹配的 ZIP 解压到 WHMCS 根目录。
  2. WHMCS 后台 → Setup → Apps & Integrations → WHMCS DataGen → Activate。
  3. Configuration → Addon Modules → 勾选 admin role + 保存。
  4. Addons → WHMCS DataGen 进入控制台。

2. 仪表盘

仪表盘看到：

  • 「生成数据」面板：选生成数量（客户 / 产品 / 订单 / 发票 / 工单）+ 开始时间偏移
  • 「批次历史」：每次生成成为一个 batch，含数量摘要 + 创建时间
  • 「全部清理」：一键删除所有 datagen 写入的数据

3. 第一次生成

「生成数据」面板：

  1. 客户：5（默认）
  2. 产品：默认包托管 / 域名等模板
  3. 订单：每客户 1 个
  4. 发票：自动生成
  5. 工单：每客户 1 个
  6. 「开始生成」→ 后台 AJAX 异步执行
  7. 完成后看「批次历史」新增一行

4. 数据细节

  • 客户：随机姓名 / 邮箱 / 电话（用 Faker 库本地生成，不调外部 API）
  • 产品：自动 use 默认 hosting product 或创建演示产品
  • 订单：随机 status（active / pending / cancelled）
  • 发票：根据订单自动建（含 paid / unpaid / overdue 状态）
  • 工单：随机 subject / message + admin response

5. 清理

  • 「按批次清理」：单个 batch 删除（删该批次写的所有数据）
  • 「全部清理」：所有 datagen 数据一次清空（保留 default products）

清理走 Capsule transaction，要么全成功要么全回滚。

6. 高级用法

  • 场景：通过 lib/scenarios/GeneralScenario.php 自定义生成逻辑
  • 扩展模板：写新 scenario class 接 whmcs_datagen_run_scenario hook
  • WHMCS API 测试：生成大量数据测试客户列表分页 / 报表

7. 常见问题

Q：会污染我的生产数据吗？ A：所有生成数据都写真实 WHMCS 表，但带 batch_id 标记。强烈建议只在测试环境用。生产环境清理时仍可按 batch_id 精确删除，但风险大。

Q：生成的客户能登录吗？ A：默认密码 Test1234!（每个生成客户都一样），可登录测试客户区。

Q：清理后能恢复吗？ A：不能 — 是真删。生成前先备份数据库。

Q：和真客户混在一起怎么区分？ A：客户 notes 含 [datagen-batch=XXX] 标记，admin 看 notes 就能识别。

更多深入文档（场景扩展、Faker 模板自定义）见商城内的「完整文档」。