A result encapsulates a value or an error and simplifies the handling of those. More...

Inheritance diagram for ILIAS\Data\Result\Error:

Collaboration diagram for ILIAS\Data\Result\Error:

Public Member Functions

__construct ($error)

isOK ()

Get to know if the result is ok. More...

value ()

Get the encapsulated value.

Returns: mixed

Exceptions

Exception if !isOK, will either throw the contained exception or a NotOKException if a string is contained as error. More...

isError ()

Get to know if the result is an error. More...

error ()

Get the encapsulated error.

Returns: \Exception|string

Exceptions

LogicException if isOK More...

valueOr ($default)

Get the encapsulated value or the supplied default if result is an error.

Parameters

mixed $default

Returns: mixed

More...

map (callable $f)

Create a new result where the contained value is modified with $f.Does nothing if !isOK.

Parameters

callable $f mixed -> mixed

More...

then (callable $f)

Get a new result from the callable or do nothing if this is an error.If null is returned from $f, the result is not touched.Does nothing if !isOK. This is monadic bind.

Parameters

callable $f mixed -> Result|null

Exceptions

UnexpectedValueException If callable returns no instance of Result More...

except (callable $f)

Feed the error into a callable and replace this with the result or do nothing if this is a value.If null is returned from $f, the error in the result is not touched.Does nothing if !isError.

Parameters

callable $f string|\Exception -> Result|null

Exceptions

UnexpectedValueException If callable returns no instance of Result More...

isOK ()

Get to know if the result is ok. More...

value ()

Get the encapsulated value. More...

isError ()

Get to know if the result is an error. More...

error ()

Get the encapsulated error. More...

valueOr ($default)

Get the encapsulated value or the supplied default if result is an error. More...

map (callable $f)

Create a new result where the contained value is modified with $f. More...

then (callable $f)

Get a new result from the callable or do nothing if this is an error. More...

except (callable $f)

Feed the error into a callable and replace this with the result or do nothing if this is a value. More...

Protected Attributes
	$error

Detailed Description

A result encapsulates a value or an error and simplifies the handling of those.

Author: Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 31 of file Error.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Data\Result\Error::__construct ( $error )

Definition at line 38 of file Error.php.

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

References ILIAS\Data\Result\Error\$error, and ILIAS\Data\Result\Error\error().

Here is the call graph for this function:

Member Function Documentation

◆ error()

ILIAS\Data\Result\Error::error ( )

Get the encapsulated error.

Returns: \Exception|string

Exceptions

LogicException if isOK

Implements ILIAS\Data\Result.

Definition at line 77 of file Error.php.

    {
        return $this->error;
    }

References ILIAS\Data\Result\Error\$error.

Referenced by ILIAS\Data\Result\Error\__construct(), ILIAS\Data\Result\Error\except(), and ILIAS\Data\Result\Error\value().

Here is the caller graph for this function:

◆ except()

ILIAS\Data\Result\Error::except ( callable $f )

Feed the error into a callable and replace this with the result or do nothing if this is a value.If null is returned from $f, the error in the result is not touched.Does nothing if !isError.

Parameters

callable $f string|\Exception -> Result|null

Exceptions

UnexpectedValueException If callable returns no instance of Result

Implements ILIAS\Data\Result.

Definition at line 109 of file Error.php.

                                       : 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;
    }

References Vendor\Package\$f, and ILIAS\Data\Result\Error\error().

Here is the call graph for this function:

◆ isError()

ILIAS\Data\Result\Error::isError ( )

Get to know if the result is an error.

Implements ILIAS\Data\Result.

Definition at line 69 of file Error.php.

                             : bool
    {
        return true;
    }

◆ isOK()

ILIAS\Data\Result\Error::isOK ( )

Get to know if the result is ok.

Implements ILIAS\Data\Result.

Definition at line 49 of file Error.php.

                          : bool
    {
        return false;
    }

◆ map()

ILIAS\Data\Result\Error::map ( callable $f )

Create a new result where the contained value is modified with $f.Does nothing if !isOK.

Parameters

callable $f mixed -> mixed

Implements ILIAS\Data\Result.

Definition at line 93 of file Error.php.

                                    : Result
    {
        return $this;
    }

◆ then()

ILIAS\Data\Result\Error::then ( callable $f )

Get a new result from the callable or do nothing if this is an error.If null is returned from $f, the result is not touched.Does nothing if !isOK. This is monadic bind.

Parameters

callable $f mixed -> Result|null

Exceptions

UnexpectedValueException If callable returns no instance of Result

Implements ILIAS\Data\Result.

Definition at line 101 of file Error.php.

                                     : Result
    {
        return $this;
    }

◆ value()

ILIAS\Data\Result\Error::value ( )

Get the encapsulated value.

Returns: mixed

Exceptions

Exception if !isOK, will either throw the contained exception or a NotOKException if a string is contained as error.

Implements ILIAS\Data\Result.

Definition at line 57 of file Error.php.

    {
        if ($this->error instanceof \Exception) {
            throw $this->error;
        }
 
        throw new Data\NotOKException($this->error);
    }

References ILIAS\Data\Result\Error\$error, and ILIAS\Data\Result\Error\error().

Here is the call graph for this function:

◆ valueOr()

ILIAS\Data\Result\Error::valueOr ( $default )

Get the encapsulated value or the supplied default if result is an error.

Parameters

mixed $default

Returns: mixed

Implements ILIAS\Data\Result.

Definition at line 85 of file Error.php.

    {
        return $default;
    }

Field Documentation

◆ $error

ILIAS\Data\Result\Error::$error

protected

Definition at line 36 of file Error.php.

Referenced by ILIAS\Data\Result\Error\__construct(), ILIAS\Data\Result\Error\error(), and ILIAS\Data\Result\Error\value().

The documentation for this class was generated from the following file:

components/ILIAS/Data/src/Result/Error.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ error()

◆ except()

◆ isError()

◆ isOK()

◆ map()

◆ then()

◆ value()

◆ valueOr()

Field Documentation

◆ $error