ILIAS\Data\Result\Ok Class Reference

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

Inheritance diagram for ILIAS\Data\Result\Ok:

Collaboration diagram for ILIAS\Data\Result\Ok:

Public Member Functions
	__construct ($value)
	isOK ()
	Get to know if the result is ok. Returns bool More...
	value ()
	Get the encapsulated value. Exceptions Exception if !isOK, will either throw the contained exception or a NotOKException if a string is contained as error. Returns mixed More...
	isError ()
	Get to know if the result is an error. Returns bool More...
	error ()
	Get the encapsulated error. Exceptions LogicException if isOK Returns Exception|string More...
	valueOr ($default)
	Get the encapsulated value or the supplied default if result is an error. Parameters 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 Returns Result 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 Returns 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| -> Result|null Exceptions UnexpectedValueException If callable returns no instance of Result Returns Result More...

Protected Attributes
	$value

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 13 of file Ok.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Data\Result\Ok::__construct

(

$value

)

Definition at line 21 of file Ok.php.

References ILIAS\Data\Result\Ok\$value, and ILIAS\Data\Result\Ok\value().

    {
        $this->value = $value;
    }

Here is the call graph for this function:

Member Function Documentation

error()

ILIAS\Data\Result\Ok::error

(

)

Get the encapsulated error.

Exceptions

LogicException

if isOK

Returns

Exception|string

Implements ILIAS\Data\Result.

Definition at line 53 of file Ok.php.

    {
        throw new \LogicException("This is a OK result. No error message available");
    }

except()

ILIAS\Data\Result\Ok::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| -> Result|null

Exceptions

UnexpectedValueException

If callable returns no instance of Result

Returns

Result

Implements ILIAS\Data\Result.

Definition at line 98 of file Ok.php.

    {
        return $this;
    }

isError()

ILIAS\Data\Result\Ok::isError

(

)

Get to know if the result is an error.

Returns

bool

Implements ILIAS\Data\Result.

Definition at line 45 of file Ok.php.

    {
        return false;
    }

isOK()

ILIAS\Data\Result\Ok::isOK

(

)

Get to know if the result is ok.

Returns

bool

Implements ILIAS\Data\Result.

Definition at line 29 of file Ok.php.

    {
        return true;
    }

map()

ILIAS\Data\Result\Ok::map

(

callable

$f

)

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

Parameters

callable

$f

mixed -> mixed

Returns

Result

Implements ILIAS\Data\Result.

Definition at line 69 of file Ok.php.

References ILIAS\Data\Result\Ok\$value, and ILIAS\Data\Result\Ok\value().

    {
        $clone = clone $this;
        $value = $f($this->value);
        $clone->value = $value;
        return $clone;
    }

Here is the call graph for this function:

then()

ILIAS\Data\Result\Ok::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

Returns

Result

Implements ILIAS\Data\Result.

Definition at line 80 of file Ok.php.

References $result, and ILIAS\Data\Result\Ok\value().

    {
        $result = $f($this->value);

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

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

        return $result;
    }

Here is the call graph for this function:

value()

ILIAS\Data\Result\Ok::value

(

)

Get the encapsulated value.

Exceptions

Exception

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

Returns

mixed

Implements ILIAS\Data\Result.

Definition at line 37 of file Ok.php.

References ILIAS\Data\Result\Ok\$value.

Referenced by ILIAS\Data\Result\Ok\__construct(), ILIAS\Data\Result\Ok\map(), and ILIAS\Data\Result\Ok\then().

    {
        return $this->value;
    }

Here is the caller graph for this function:

valueOr()

ILIAS\Data\Result\Ok::valueOr

(

$default

)

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

Parameters

default

Returns

mixed

Implements ILIAS\Data\Result.

Definition at line 61 of file Ok.php.

References ILIAS\Data\Result\Ok\$value.

    {
        return $this->value;
    }

Field Documentation

$value

ILIAS\Data\Result\Ok::$value

protected

Definition at line 19 of file Ok.php.

Referenced by ILIAS\Data\Result\Ok\__construct(), ILIAS\Data\Result\Ok\map(), ILIAS\Data\Result\Ok\value(), and ILIAS\Data\Result\Ok\valueOr().

---

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

• src/Data/Result/Ok.php