divineomega/github-status-api

编程方式判断GitHub是否运行良好,或存在问题

v1.0.0 2018-12-07 23:11 UTC

This package is auto-updated.

Last update: 2024-09-17 10:51:46 UTC


README

Build Status

⚠️ 警告:自2018年12月11日起,GitHub已弃用该包解析的状态页面,因此当前状态信息可能不是最新的。更多信息:https://blog.github.com/2018-12-11-introducing-the-new-github-status-site/

该包提供了一种编程方式来确定GitHub是否运行良好,或存在问题。可以通过日期查找当前状态和历史状态。

安装

要安装PHP GitHub Status API,只需运行以下composer命令。

composer require divineomega/github-status-api

请记住,如果您的框架没有这样做,请包含vendor/autoload.php文件。

用法

要检查GitHub当前的状态,只需创建一个新的Client对象,并调用其status方法。您可以选择将一个Carbon日期对象传递给status方法以获取历史状态。

use Carbon\Carbon;
use DivineOmega\GitHubStatusApi\Client;
use DivineOmega\GitHubStatusApi\Enums\GitHubStatus;

require_once 'vendor/autoload.php';

$status    = (new Client())->status();
// $status = (new Client())->status(Carbon::parse('2018-12-06 17:00'));

switch ($status) {
    case GitHubStatus::GOOD:
        echo 'GitHub is up! No issues reported.';
        break;

    case GitHubStatus::MINOR:
        echo 'GitHub is experiencing minor issues.';
        break;

    case GitHubStatus::MAJOR:
        echo 'GitHub is experiencing major issues.';
        break;

    case GitHubStatus::UNKNOWN:
        echo 'Unable to determine GitHub\'s status.';
        break;
}

echo PHP_EOL;