A constraint encodes some resrtictions on values. More...

Inheritance diagram for ILIAS\Validation\Constraint:

Collaboration diagram for ILIAS\Validation\Constraint:

Public Member Functions
	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...

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

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

Detailed Description

A constraint encodes some resrtictions on values.

Constraints MUST NOT modify the supplied value.

Definition at line 14 of file Constraint.php.

Member Function Documentation

◆ accepts()

ILIAS\Validation\Constraint::accepts ( $value )

Tells if the provided value complies.

Parameters

mixed $value

Returns: bool

Implemented in ILIAS\Validation\Constraints\Custom.

Referenced by ILIAS\Validation\Constraints\IsArrayOf\__construct().

Here is the caller graph for this function:

◆ check()

ILIAS\Validation\Constraint::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

Implemented in ILIAS\Validation\Constraints\Custom.

◆ problemWith()

ILIAS\Validation\Constraint::problemWith ( $value )

Tells what the problem with the provided value is.

Should return null if accepts($value).

Parameters

mixed $value

Returns: string|null

Implemented in ILIAS\Validation\Constraints\Custom.

Referenced by ILIAS\Validation\Constraints\IsArrayOf\__construct().

Here is the caller graph for this function:

◆ restrict()

ILIAS\Validation\Constraint::restrict ( 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