fab2s/context-exception

A context exception interface and implementation

3.0.0 2023-01-04 07:45 UTC

Requires

• php: ^7.1 || ^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.13
• phpunit/phpunit: 9.*|8.*|7.*

MIT

• Fabrice de Stefanis

• php
• exception
• Context
• interface

README

Exception logging proves particularly useful to monitor application failure, but as it is, cannot provide with contextual data that could help out when processing those exception logs.

This Exception interface and implementation is just a step towards providing context to exceptions allowing you to interact with such exception and log them together with the extra information you would have provided.

It goes particularly well with Monolog and global exception handling where you can directly and globally add exception context to your log (when available) which may be of virtually any nature (monolog has a lot of handler and you can add more yourself to suite your need).

In your exception handler (or just a try{}catch{}:

if ($exception instanceof ContextExceptionInterface) {
    $context = $exception->getContext();
    // now you can add this data to your monolog's context
}

Setting context can be achieved in several ways :

// arguable way
throw (new ContextException('Message'))->setContext($contextData);

// or more conventional
throw new ContextException('Message', 0, null, $contextData);

// or step by step (also arguable)
$exception = new ContextException;
$exception->setContext($contextData);
throw $exception;

IMHO, the arguability of some of the way to provide context to exceptions does not match the usefulness they provide IRL. I'm not saying that the conventional way to throw should not be in principle preferred, but I definitely find IRL use for things like :

} catch (ContextException $e) {
    // access context
    $context = $e->getContext();
    // set context in case there is none
    $e->setContext($context);
}

And from there, you get mutability so ...

Installation

ContextException can be installed using composer:

composer require "fab2s/context-exception"

V3.x introduces a breaking change in the ContextExceptionInterface which no more includes a signature for the constructor or even a merge function. It introduce and handy ContextExceptionTrait you can use to implement your own implementation of ContextExceptionInterface without having to inherit ContextException

If you want to stick to the previous interface :

composer require "fab2s/context-exception" ^2

If you want to specifically install the php >=7.1.0 version, use:

composer require "fab2s/context-exception" ^1

If you want to specifically install the php 5.6/7.0 version, use:

composer require "fab2s/context-exception" ^0

Requirements

ContextException is tested against php 7.1, 7.2, 7.3, 7.4, 8.0, 8.1 and 8.2

License

ContextException is open-sourced software licensed under the MIT license.