ILIAS\Validation\Constraints\Custom Class Reference

Inheritance diagram for ILIAS\Validation\Constraints\Custom:

Collaboration diagram for ILIAS\Validation\Constraints\Custom:

Public Member Functions
	__construct (callable $is_ok, $error, Data\Factory $data_factory)
	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...
	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 $value 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. Parameters callable $builder mixed -> string 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...
	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...

Protected Attributes
	$data_factory
	$is_ok
	$error

Detailed Description

Definition at line 10 of file Custom.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Validation\Constraints\Custom::__construct	(	callable	$is_ok,
			$error,
		Data\Factory	$data_factory
	)

Parameters

string | callable

$error

Definition at line 30 of file Custom.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;
    }

References ILIAS\Validation\Constraints\Custom\$data_factory, ILIAS\Validation\Constraints\Custom\$error, ILIAS\Validation\Constraints\Custom\$is_ok, and error().

Here is the call graph for this function:

Member Function Documentation

accepts()

ILIAS\Validation\Constraints\Custom::accepts (   $value )

final

Tells if the provided value complies.

Parameters

mixed

$value

Returns

bool

Implements ILIAS\Validation\Constraint.

Definition at line 60 of file Custom.php.

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

Referenced by ILIAS\Validation\Constraints\Custom\check(), and ILIAS\Validation\Constraints\Custom\problemWith().

Here is the caller graph for this function:

check()

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

Definition at line 48 of file Custom.php.

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

References ILIAS\Validation\Constraints\Custom\accepts(), and ILIAS\Validation\Constraints\Custom\getErrorMessage().

Here is the call graph for this function:

getErrorMessage()

ILIAS\Validation\Constraints\Custom::getErrorMessage (   $value )

final

Get the problem message.

Returns

string

Definition at line 110 of file Custom.php.

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

References error().

Referenced by ILIAS\Validation\Constraints\Custom\check(), and ILIAS\Validation\Constraints\Custom\problemWith().

Here is the call graph for this function:

Here is the caller graph for this function:

problemWith()

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

Definition at line 68 of file Custom.php.

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

References ILIAS\Validation\Constraints\Custom\accepts(), and ILIAS\Validation\Constraints\Custom\getErrorMessage().

Referenced by ILIAS\Validation\Constraints\Custom\restrict().

Here is the call graph for this function:

Here is the caller graph for this function:

restrict()

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

$value

Returns

Result

Implements ILIAS\Validation\Constraint.

Definition at line 80 of file Custom.php.

    {
        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\Validation\Constraints\Custom\$error, $result, ILIAS\Validation\Constraints\Custom\problemWith(), and ILIAS\Data\Result\value().

Here is the call graph for this function:

withProblemBuilder()

ILIAS\Validation\Constraints\Custom::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.

Parameters

callable

$builder

mixed -> string

Returns

Constraint

Implements ILIAS\Validation\Constraint.

Definition at line 98 of file Custom.php.

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

References $builder.

Field Documentation

$data_factory

ILIAS\Validation\Constraints\Custom::$data_factory

protected

Definition at line 15 of file Custom.php.

Referenced by ILIAS\Validation\Constraints\LessThan\__construct(), ILIAS\Validation\Constraints\GreaterThan\__construct(), ILIAS\Validation\Constraints\Parallel\__construct(), ILIAS\Validation\Constraints\Sequential\__construct(), ILIAS\Validation\Constraints\Custom\__construct(), ILIAS\Validation\Constraints\Not\__construct(), and ILIAS\Validation\Constraints\IsInt\__construct().

$error

ILIAS\Validation\Constraints\Custom::$error

protected

Definition at line 25 of file Custom.php.

Referenced by ILIAS\Validation\Constraints\Custom\__construct(), and ILIAS\Validation\Constraints\Custom\restrict().

$is_ok

ILIAS\Validation\Constraints\Custom::$is_ok

protected

Definition at line 20 of file Custom.php.

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

---

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

• src/Validation/Constraints/Custom.php