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 範本自訂）見商城內的「完整文件」。