README

这是PHP的错误追踪SDK的核心。该库用于通过PHP与错误追踪API交互。您也可以使用此包为纯PHP应用程序注册错误处理器。

适合谁使用？

您可以使用composer安装此包。

composer require erorr-traker/php-sdk

API客户端类可用于访问错误追踪API

use ErrorTracker\Client;

$client = new Client('APP_KEY');

$client->report([
    'name' => 'The error name',
    'text' => 'A message about the error'
]);

如果您使用的是纯PHP应用程序，您可以注册错误处理器来捕获错误并将它们直接发送到错误追踪。只需创建一个新的Handler类实例。

use ErrorTracker\Handler;

new Handler('MY_APP_KEY');

使用Handler类的enabled属性禁用和启用发送错误

$handler = new Handler('MY_APP_KEY');

// Turn off
$handler->enabled = false;

// Turn back on
$handler->enabled = true;

使用unregister函数注销处理器

$handler->unregister();

克隆存储库并运行composer install。然后开始修改！

所有新特性和错误修复都必须经过测试。测试使用phpunit进行，可以使用以下命令运行：

composer run-script test

该库使用psr2编码标准以及squizlabs/php_codesniffer进行代码审查。为此提供了一个composer脚本。

composer run-script lint

在创建包含您的更改的拉取请求之前，预提交脚本必须通过。可以这样运行：

composer run-script pre-commit

此包由Practically.io创建和维护。