wyrihaximus/psr-3-callable-throwable-logger

callable throwable decorator around a PSR-3 logger (to be used with react/promise and reactivex/rxphp)

2.3.1 2023-01-14 19:24 UTC

Requires

• php: ^8 || ^7.4.7
• psr/log: ^3 || ^2 || ^1
• thecodingmachine/safe: ^2 || ^1.0 || ^0.1.16

Requires (Dev)

• wyrihaximus/psr-3-utilities: ^1.0
• wyrihaximus/test-utilities: ^5 || ^3.7.3

MIT

• Cees-Jan Kiewiet

README

Installation

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/psr-3-callable-throwable-logger 

Usage with react/promise

Whenever a promise rejects the closure from CallableThrowableLogger::create will be invoked and an error message will be logged to $logger

$logger = new Psr3Logger();
$reactPromise->done(function () {
    // Happy flow handler
}, CallableThrowableLogger::create($logger));

Usage with reactivex/rxphp

Whenever an errors comes from the stream the closure from CallableThrowableLogger::create will be invoked and and error message will be logged to $logger.

$logger = new Psr3Logger();
$rxPhpStream->subscribute(function ($item) {
    // Items handler
}, CallableThrowableLogger::create($logger), function () {
    // Done
});

Optional arguments

CallableThrowableLogger::create(
    $logger, // required: PSR-3 logger
    'error', // optional: Message level
    'Uncaught Throwable %1$s: "%2$s" at %3$s line %4$s', // optional: Message
    // %1$s => the throwable classname
    // %2$s => the throwable message 
    // %3$s => the throwable file 
    // %4$s => the throwable line 
);

Contributing

Please see CONTRIBUTING for details.

License

Copyright 2018 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.