ankane/exceptional-php

The power of Exceptional for PHP

Exceptional PHP

The power of Exceptional for PHP, _(*1)

Super simple setup

require "path/to/exceptional.php";
Exceptional::setup("YOUR-API-KEY");

You can turn off exception notifications by passing an empty string as the API key. This is great for development., _(*2)

if (PHP_ENV == "production") {
  $api_key = "YOUR-API-KEY";
}
else {
  $api_key = "";
}

Exceptional::setup($api_key);

You can turn on SSL by setting the second parameter to true., _(*3)

Exceptional::setup($api_key, true);

Filtering sensitive data

You can blacklist sensitive fields from being submitted to Exceptional:, _(*4)

Exceptional::setup($api_key);
Exceptional::blacklist(array('password', 'creditcardnumber'));

Exceptions and errors

Exceptional PHP catches both errors and exceptions. You can control which errors are caught. If you want to ignore certain errors, use error_reporting(). Here's a common setting:, _(*5)

error_reporting(E_ALL & ~E_NOTICE);  // ignore notices

Custom error and exception handlers are supported - see examples/advanced.php., _(*6)

Fatal and parse errors are caught, too - as long the setup file parses correctly., _(*7)

404 support

Add the following code to your 404 handler to track 404 errors:, _(*8)

throw new Http404Error();

Send extra data with your exceptions

$context = array(
    "user_id" => 1
);
Exceptional::context($context);

See the Exceptional documentation for more details., _(*9)

Controller + action support

You can include the controller and action names in your exceptions for easier debugging., _(*10)

Exceptional::$controller = "welcome";
Exceptional::$action = "index";

Proxy server

You can send exceptions through proxy server (no support for authentication)., _(*11)

Exceptional::proxy($host, $port);