Error.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Data\Result;

use ILIAS\Data;
use ILIAS\Data\Result;

class Error implements Data\Result
{
    protected $error;

    public function __construct($error)
    {
        if (!is_string($error) && !($error instanceof \Exception)) {
            throw new \InvalidArgumentException("Expected error to be a string or an Exception.");
        }
        $this->error = $error;
    }

    public function isOK(): bool
    {
        return false;
    }

    public function value()
    {
        if ($this->error instanceof \Exception) {
            throw $this->error;
        }

        throw new Data\NotOKException($this->error);
    }

    public function isError(): bool
    {
        return true;
    }

    public function error()
    {
        return $this->error;
    }

    public function valueOr($default)
    {
        return $default;
    }

    public function map(callable $f): Result
    {
        return $this;
    }

    public function then(callable $f): Result
    {
        return $this;
    }

    public function except(callable $f): Result
    {
        $result = $f($this->error);

        if ($result === null) {
            return $this;
        }

        if (!$result instanceof Data\Result) {
            throw new \UnexpectedValueException("The returned type of callable is not an instance of interface Result");
        }

        return $result;
    }
}