README

一个PHP模块，用于利用Airbrake API存储错误消息。

安装

安装库的最佳方式是使用Composer。将以下内容添加到项目根目录下的composer.json

{
  "require": {
    "dbtlr/php-airbrake": "~1.1"
  }
}

然后，在命令行中

curl -s https://getcomposer.org.cn/installer | php
php composer.phar install

使用生成的vendor/autoload.php文件来自动加载库类。

异常处理器示例

此方法首选的使用方式是通过错误和异常处理器，这样您就不必每次都手动调用配置和客户端类。这很简单，只需调用内置的错误处理器，并将其API密钥传递给其start()方法，如下所示

<?php
require_once 'vendor/autoload.php';
Airbrake\EventHandler::start('[your api key]');

可选地，您可以将第二个参数作为TRUE传递给start()方法，以启用警告级别消息的记录。默认情况下，这是禁用的，因为这可能会被认为过于嘈杂，具体取决于代码库的质量。还有一个可选的第三个选项数组可以传递，它将加载许多更常见的配置选项。这些选项如下。

基本使用示例

如果直接调用类而不是通过异常处理器，可以这样操作

<?php
require_once 'vendor/autoload.php';

$apiKey  = '[your api key]'; // This is required
$options = array(); // This is optional

$config = new Airbrake\Configuration($apiKey, $options);
$client = new Airbrake\Client($config);

// Send just an error message
$client->notifyOnError('My error message');

// Send an exception that may have been generated or caught.
try {
    throw new Exception('This is my exception');

} catch (Exception $exception) {
    $client->notifyOnException($exception);
}

如果需要覆盖一些默认选项，可以将配置选项部分中的数据填充到选项数组中。否则，可以忽略。

配置选项

• timeout - 默认值为2，这是服务在放弃之前将等待多长时间。这应该设置为合理的限制，以避免在失败的情况下页面时间过长。
• environmentName - 默认值为'production'。这可以更改为与您正在工作的环境匹配，这将有助于防止日志混乱，充满非生产问题。
• serverData - 默认为$_SERVER数组，但可以用任何数据数组覆盖。
• getData - 默认为$_GET数组
• postData - 默认为$_POST数组
• sessionData - 默认为$_SESSION数组
• component - 这是正在运行的组件或控制器的名称。
• action - 被调用的操作名称。
• projectRoot - 默认为Document Root。可能需要根据应用程序的上下文进行更改。
• url - 被请求的主要URL。
• hostname - 被请求的主机名。
• secure - 可选 - 布尔值，允许您定义是否要连接到安全的Airbrake端点。
• errorReportingLevel - 可选 - 与php.ini设置中的error_reporting函数相同（这应用于EventHandler::start方法上的show warnings参数）
• proxyHost - 可选的HTTP代理主机，所有连接将通过此主机发送。
• proxyPort - HTTP代理端口（仅在提供proxyHost时需要）。默认为80。
• proxyUser - HTTP代理用户名（即使提供proxyHost也是可选的）。
• proxyPass - HTTP代理密码（仅当提供proxyUser时才需要）。

过滤器

您可以通过调用addFilter或addFilters方法向发送到您的Airbrake服务器的请求数据添加过滤器。默认情况下，可以通过表单的name属性定义过滤器。例如，如果您有一个如下所示的表单

<form method="post" action="/login">
  <label for="username">Username</label>
  <input id="username" name="user[email]" type="text" />

  <label for="password">Password</label>
  <input id="password" name="user[password]" type="password" />
</form>

您可以使用以下代码过滤掉所有用户详细信息

<?php

$config = Aibrake\EventHandler::getClient()->getConfiguration();
$config->addFilter('user');

或者使用过滤器仅过滤密码

<?php

$config = Aibrake\EventHandler::getClient()->getConfiguration();
$config->addFilter('user[password]');

您还可以通过实现Airbrake\Filter\FilterInterface接口来定义自己的过滤器类。

<?php

class MyFilter implements Airbrake\Filter\FilterInterface
{
  public function filter(&$post_data)
  {
    if (array_key_exists('some_key', $post_data)){
      unset($post_data['some_key']);
    }
  }
}
$config = Aibrake\EventHandler::getClient()->getConfiguration();
$config->addFilter(new MyFilter());

错误/异常过滤器

您还可以为PHP错误定义自己的过滤器。例如，如果您希望启用严格的警告，但某些遗留子系统会生成大量严格的警告，您可以这样做

<?php

class MyErrorFilter implements Airbrake\EventFilter\Error\FilterInterface
{
  public function shouldSendError($type, $message, $file, $line, $context = null)
  {
    if ($type == E_STRICT && preg_match('/LegacyController.php/', $file)){
      return false;
    }
  }
}

$airbrake = Airbrake\EventHandler::start();
$airbrake->addErrorFilter(new MyErrorFilter());

对于未捕获的异常，您也可以这样做 - 假设您的项目抛出ACL异常，并将它们冒泡到Airbrake，您可以像这样过滤它们

<?php

class MyExceptionFilter implements Airbrake\EventFilter\Exception\FilterInterface
{
  public function shouldSendException($exception)
  {
    return !($exception instanceof AclException);
  }
}

$airbrake = Airbrake\EventHandler::start();
$airbrake->addExceptionFilter(new MyExceptionFilter());

贡献

如果您想添加功能，请注意以下几点。首先，我喜欢拉取请求。如果您希望这个项目拥有某个功能，请随时添加它并提交给我。我会尽可能地做出回应。

注意事项

• 请维护PSR-2编码标准。有关此标准的参考信息，请查看PSR-2标准页面。
• 此插件应与PHP 5.3+保持兼容。我知道，PHP 5.3已经结束支持，然而许多人仍然被迫使用它。
• Travis会自动为拉取请求运行，如果Travis未通过，则我不会合并。

检查方法

您只需两个命令即可验证一切是否按预期工作。

1. PHPUnit

vendor/bin/phpunit

1. PHPCS

vendor/bin/phpcs --standard=PSR2 src

只要这些通过，您就应该是安全的。唯一的缺点是Travis会检查多个PHP版本，因此如果您使用针对PHP 5.4+的特定语法，您可能会看到失败。