dxw/result

Result values

v1.0.6 2023-07-19 11:14 UTC

Requires

• php: ^7.4||^8.1

Requires (Dev)

• dxw/php-cs-fixer-config: ^2.1
• kahlan/kahlan: ^5.2
• vimeo/psalm: ^4

MIT

• Mallory Adams

README

Meant to be a drop-in replacement for nikita2206/result, with one addition: wrap().

wrap() was inspired by github.com/pkg/errors.

Installation

composer require dxw/result

Usage

Returning values:

function myfunc(): \Dxw\Result\Result
{
    if (/* error */) {
        // getErr() will return 'something went wrong'
        return \Dxw\Result\Result::err('something went wrong');
    }

    return \Dxw\Result\Result::ok($value);
}

Handling Result values:

$result = myfunc();
if ($result->isErr()) {
    echo sprintf("Error: %s\n", $result->getErr());
    exit(1);
}
$value = $result->unwrap();

Returning errors from other errors:

function anotherfunc(): \Dxw\Result\Result
{
    $result = myfunc();
    if ($result->isErr()) {
        // getErr() will return 'got invalid value: something went wrong'
        return $result->wrap('got invalid value');
    }
    // do something with $result->unwrap()
}