ILIAS\Refinery\Custom\Constraint Class Reference

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)
	Checks the provided value.Should not throw if accepts($value). Exceptions UnexpectedValueException if value does not comply with encoded constraint. Parameters mixed $value Returns null More...
	accepts ($value)
	Tells if the provided value complies. Parameters mixed $value Returns bool More...
	problemWith ($value)
	Tells what the problem with the provided value is.Should return null if accepts($value). Parameters mixed $value Returns string|null More...
	applyTo (Result $result)
	Restricts a Result.Must do nothing with the result if $result->isError(). Must replace the result with an error according to problemWith() if !accepts($result->value()). Parameters Result $result Returns Result More...
	withProblemBuilder (callable $builder)
	Get a constraint like this one with a builder for a custom error message.problemWith() must return an error message according to the new builder for the new constraint.The builder needs to be callable that takes two parameters: Parameters callable $builder Returns Constraint More...
	getErrorMessage ($value)
	Get the problem message. More...
	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 $data)
	Perform the transformation and reify possible failures. More...
	__invoke ($from)
	Transformations should be callable. More...

Protected Member Functions
	getLngClosure ()
	Get the closure to be passed to the error-function that does i18n and sprintf. More...

Protected Attributes
	$data_factory
	$lng
	$is_ok
	$error

Detailed Description

Definition at line 12 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

string | callable

$error

Definition at line 46 of file Constraint.php.

    {
        $this->is_ok = $is_ok;
 
        if (!is_callable($error)) {
            $this->error = function () use ($error) {
                return $error;
            };
        } else {
            $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, and error().

Here is the call graph for this function:

Member Function Documentation

accepts()

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

final

Tells if the provided value complies.

Parameters

mixed

$value

Returns

bool

Implements ILIAS\Refinery\Constraint.

Definition at line 77 of file Constraint.php.

    {
        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

Restricts a Result.Must do nothing with the result if $result->isError(). Must replace the result with an error according to problemWith() if !accepts($result->value()).

Parameters

Result

$result

Returns

Result

Implements ILIAS\Refinery\Constraint.

Definition at line 97 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, $result, 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

Checks the provided value.Should not throw if accepts($value).

Exceptions

UnexpectedValueException if value does not comply with encoded constraint.

Parameters

mixed

$value

Returns

null

Implements ILIAS\Refinery\Constraint.

Definition at line 65 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\Custom\Constraint\getErrorMessage().

Here is the call graph for this function:

getErrorMessage()

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

final

Get the problem message.

Returns

string

Definition at line 127 of file Constraint.php.

    {
        $lng_closure = $this->getLngClosure();
        return call_user_func($this->error, $lng_closure, $value);
    }

References error(), and ILIAS\Refinery\Custom\Constraint\getLngClosure().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLngClosure()

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

finalprotected

Get the closure to be passed to the error-function that does i18n and sprintf.

Returns

\Closure

Definition at line 139 of file Constraint.php.

    {
        return function () {
            $args = func_get_args();
            if (count($args) < 1) {
                throw new \InvalidArgumentException(
                    "Expected an id of a lang var as first parameter"
                );
            }
            $error = $this->lng->txt($args[0]);
            if (count($args) > 1) {
                $args[0] = $error;
                for ($i = 0; $i < count($args); $i++) {
                    $v = $args[$i];
                    if ((is_array($v) || is_object($v) || is_null($v))
                    && !method_exists($v, "__toString")) {
                        if (is_array($v)) {
                            $args[$i] = "array";
                        } elseif (is_null($v)) {
                            $args[$i] = "null";
                        } else {
                            $args[$i] = get_class($v);
                        }
                    }
                }
                $error = call_user_func_array("sprintf", $args);
            }
            return $error;
        };
    }

References ILIAS\Refinery\Custom\Constraint\$error, and $i.

Referenced by ILIAS\Refinery\Custom\Constraint\getErrorMessage().

Here is the caller graph for this function:

problemWith()

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

final

Tells what the problem with the provided value is.Should return null if accepts($value).

Parameters

mixed

$value

Returns

string|null

Implements ILIAS\Refinery\Constraint.

Definition at line 85 of file Constraint.php.

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

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

Referenced by ILIAS\Refinery\Custom\Constraint\applyTo().

Here is the call graph for this function:

Here is the caller graph for this function:

withProblemBuilder()

ILIAS\Refinery\Custom\Constraint::withProblemBuilder ( callable  $builder )

final

Get a constraint like this one with a builder for a custom error message.problemWith() must return an error message according to the new builder for the new constraint.The builder needs to be callable that takes two parameters:

Parameters

callable

$builder

Returns

Constraint

Implements ILIAS\Refinery\Constraint.

Definition at line 115 of file Constraint.php.

    {
        $clone = clone $this;
        $clone->error = $builder;
        return $clone;
    }

References $builder.

Field Documentation

$data_factory

ILIAS\Refinery\Custom\Constraint::$data_factory

protected

Definition at line 20 of file Constraint.php.

Referenced by ILIAS\Refinery\Custom\Constraint\__construct(), ILIAS\Refinery\IsNull\__construct(), ILIAS\Refinery\Numeric\IsNumeric\__construct(), ILIAS\Refinery\Password\HasLowerChars\__construct(), ILIAS\Refinery\Password\HasNumbers\__construct(), ILIAS\Refinery\Password\HasSpecialChars\__construct(), ILIAS\Refinery\Password\HasUpperChars\__construct(), ILIAS\Refinery\Integer\LessThan\__construct(), ILIAS\Refinery\String\HasMaxLength\__construct(), ILIAS\Refinery\Integer\GreaterThan\__construct(), ILIAS\Refinery\Password\HasMinLength\__construct(), and ILIAS\Refinery\String\HasMinLength\__construct().

$error

ILIAS\Refinery\Custom\Constraint::$error

protected

Definition at line 35 of file Constraint.php.

Referenced by ILIAS\Refinery\Custom\Constraint\__construct(), ILIAS\Refinery\Custom\Constraint\applyTo(), and ILIAS\Refinery\Custom\Constraint\getLngClosure().

$is_ok

ILIAS\Refinery\Custom\Constraint::$is_ok

protected

Definition at line 30 of file Constraint.php.

Referenced by ILIAS\Refinery\Custom\Constraint\__construct().

$lng

ILIAS\Refinery\Custom\Constraint::$lng

protected

Definition at line 25 of file Constraint.php.

Referenced by ILIAS\Refinery\Custom\Constraint\__construct(), ILIAS\Refinery\IsNull\__construct(), ILIAS\Refinery\Numeric\IsNumeric\__construct(), ILIAS\Refinery\Password\HasLowerChars\__construct(), ILIAS\Refinery\Password\HasNumbers\__construct(), ILIAS\Refinery\Password\HasSpecialChars\__construct(), ILIAS\Refinery\Password\HasUpperChars\__construct(), ilAccessibilityDocumentCriterionAssignmentConstraint\__construct(), ilTermsOfServiceDocumentCriterionAssignmentConstraint\__construct(), ILIAS\Refinery\Integer\LessThan\__construct(), ILIAS\Refinery\String\HasMaxLength\__construct(), ILIAS\Refinery\Integer\GreaterThan\__construct(), ILIAS\Refinery\Password\HasMinLength\__construct(), and ILIAS\Refinery\String\HasMinLength\__construct().

---

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

• src/Refinery/Custom/Constraint.php