gioco-plus/grabber-log

There is no license information available for the latest version (v2.3.1) of this package.

v2.3.1 2023-05-05 03:10 UTC

Requires

• php: >=7.2
• gioco-plus/prism-plus: dev-master || >=1

Unknown License

README

• GrabberLog
  • 初始化
    • 參數說明
  • 紀錄開始
    • 參數說明
  • 紀錄結束 (成功)
    • 參數說明
  • 紀錄結束 (失敗)
    • 參數說明
  • 額外功能
    • 取得最後一筆 grabber log
      • 參數說明
    • 取得下次抓取時間
      • 參數說明

初始化

use GiocoPlus\GrabberLog\GrabberLog;

/**
 * GrabberLog constructor.
 * @param string $vendorCode
 * @param array $options
 * @throws \Exception
 */
 
$grabberLog = new GrabberLog($vendorCode, $options);

參數說明

參數	類型	說明
$vendorCode	string	遊戲商代碼
$options	array	請看 options 說明

$options

ex: $options['agent']

參數皆為選填

參數	類型	說明
agent	string	代理
record_type	string	單類型
operatorCode	string	營商代碼
fail_count_notify	int	錯誤次數達到時，發送 Line Notify 需設定 .env 內 LINE_NOTIFY_ACCESS_TOKEN，通知環境請設定 SERVICE_ENV，未設定預設 unknow

紀錄開始

$grabberLog->running($start, $extraParams);

參數說明

參數	類型	說明
$start	string	紀錄開始 id or date
$extraParams	array	紀錄額外搜尋條件，若有明確的結束時間陣列 key 請使用 end

紀錄結束 (成功)

$grabberLog->complete($extraParams);

參數說明

參數	類型	說明
$extraParams	array	提供完成時需額外紀錄

紀錄結束 (失敗)

$grabberLog->fail($extraParams, $options);

參數說明

參數	類型	說明
$extraParams	array	提供完成時需額外紀錄
$options	array	請看 options 說明

$extraParams

ex: $extraParams['error_message']

參數皆為選填

參數	類型	說明
error_message	string (300)	若有此參數，會在 Line Notify 發送時，將錯誤訊息一併送出

$options

ex: $options['maintain']

參數皆為選填

參數	類型	說明
maintain	bool	是否維護，此參數 true 時，則不會計算失敗次數及發送通知。

額外功能

取得最後一筆 grabber log

$grabberLog->lastLog($filter);

參數說明

參數	類型	說明
$filter	array	額外搜尋條件

取得下次抓取時間

僅適用 log 內有 start、end

nextGrabber ， 返回 Carbon

nextGrabberTime ， 返回 timestamp 10 位

['start' => $startTime, 'end' => $endTime] = $grabberLog->nextGrabberTime(
                    $pastMinutes,
                    $longTimeRang,
                    ['bufferNowMin' => $bufferMin]
                );

參數說明

參數	類型	說明
$past_minutes	int	過去分鐘數
$longTimeRang	int	最長時間範圍 (單位 min)
$options	array	請看 options 說明

$options

參數	類型	說明
bufferNowMin	int	距離現在時間 int (單位 min)，影響結束時間(end)
coverTimeRang	int	包含上次抓取時間 (單位 min)
lastLogFilter	array	最後一條紀錄 filter