Inheritance diagram for ILIAS\Refinery\Custom\Constraint:

Collaboration diagram for ILIAS\Refinery\Custom\Constraint:

Public Member Functions
	__construct (callable $is_ok, $error, Data\Factory $data_factory, ilLanguage $lng)
	If $error is a callable it needs to take two parameters: More...

	check ($value)
	@inheritDoc More...

	accepts ($value)
	@inheritDoc More...

	problemWith ($value)
	@inheritDoc More...

	applyTo (Result $result)
	@inheritDoc More...

Public Member Functions inherited from ILIAS\Refinery\Constraint
	check ($value)
	Checks the provided value. More...

	accepts ($value)
	Tells if the provided value complies. More...

	problemWith ($value)
	Tells what the problem with the provided value is. More...

	applyTo (Result $result)
	Restricts a Result. More...

	withProblemBuilder (callable $builder)
	Get a constraint like this one with a builder for a custom error message. More...

Public Member Functions inherited from ILIAS\Refinery\Transformation
	transform ($from)
	Perform the transformation. More...

	applyTo (Result $result)
	Perform the transformation and reify possible failures. More...

	__invoke ($from)
	Transformations should be callable. More...

Protected Member Functions
	getError ()
	@inheritDoc More...

Protected Attributes
Data Factory	$data_factory

ilLanguage	$lng

	$is_ok

	$error

Detailed Description

Definition at line 31 of file Constraint.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Refinery\Custom\Constraint::__construct	(	callable	$is_ok,
			$error,
		Data\Factory	$data_factory,
		ilLanguage	$lng
	)

If $error is a callable it needs to take two parameters:

one callback $txt($lng_id, ($value, ...)) that retrieves the lang var with the given id and uses sprintf to replace placeholder if more values are provide.
the $value for which the error message should be build.

Parameters

callable	$is_ok
string \| callable	$error
Data\Factory	$data_factory
ilLanguage	$lng

Definition at line 56 of file Constraint.php.

    {
        $this->is_ok = $is_ok;
        $this->error = $error;
        $this->data_factory = $data_factory;
        $this->lng = $lng;
    }

References ILIAS\Refinery\Custom\Constraint\$data_factory, ILIAS\Refinery\Custom\Constraint\$error, ILIAS\Refinery\Custom\Constraint\$is_ok, ILIAS\Refinery\Custom\Constraint\$lng, error(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ accepts()

ILIAS\Refinery\Custom\Constraint::accepts ( $value )

final

@inheritDoc

Implements ILIAS\Refinery\Constraint.

Definition at line 87 of file Constraint.php.

                                         : bool
    {
        return call_user_func($this->is_ok, $value);
    }

Referenced by ILIAS\Refinery\Custom\Constraint\check(), and ILIAS\Refinery\Custom\Constraint\problemWith().

Here is the caller graph for this function:

◆ applyTo()

ILIAS\Refinery\Custom\Constraint::applyTo ( Result $result )

final

@inheritDoc

Implements ILIAS\Refinery\Constraint.

Definition at line 107 of file Constraint.php.

                                                 : Result
    {
        if ($result->isError()) {
            return $result;
        }
 
        $problem = $this->problemWith($result->value());
        if ($problem !== null) {
            $error = $this->data_factory->error($problem);
            return $error;
        }
 
        return $result;
    }

References ILIAS\Refinery\Custom\Constraint\$error, ILIAS\Data\Result\isError(), ILIAS\Refinery\Custom\Constraint\problemWith(), and ILIAS\Data\Result\value().

Here is the call graph for this function:

◆ check()

ILIAS\Refinery\Custom\Constraint::check ( $value )

final

@inheritDoc

Implements ILIAS\Refinery\Constraint.

Definition at line 75 of file Constraint.php.

    {
        if (!$this->accepts($value)) {
            throw new \UnexpectedValueException($this->getErrorMessage($value));
        }
 
        return null;
    }

References ILIAS\Refinery\Custom\Constraint\accepts(), and ILIAS\Refinery\getErrorMessage().

Here is the call graph for this function:

◆ getError()

ILIAS\Refinery\Custom\Constraint::getError ( )

protected

@inheritDoc

Definition at line 67 of file Constraint.php.

    {
        return $this->error;
    }

References ILIAS\Refinery\Custom\Constraint\$error.

◆ problemWith()

ILIAS\Refinery\Custom\Constraint::problemWith ( $value )

final

@inheritDoc

Implements ILIAS\Refinery\Constraint.

Definition at line 95 of file Constraint.php.

                                             : ?string
    {
        if (!$this->accepts($value)) {
            return $this->getErrorMessage($value);
        }
 
        return null;
    }