ILIAS\Refinery Namespace Reference

Namespaces
	Container
	Custom
	DateTime
	In
	Integer
	KindlyTo
	Logical
	Numeric
	Password
	String
	To
	URI

Data Structures
class	ByTrying
interface	Constraint
	A constraint encodes some resrtictions on values. More...
class	ConstraintViolationException
class	Factory
class	IsNull
interface	Transformation
	A transformation is a function from one datatype to another. More...

Functions
	applyTo (Result $result)
	__invoke ($from)
	withProblemBuilder (callable $builder)
	getErrorMessage ($value)
	Get the problem message. More...
	getLngClosure ()
	Get the closure to be passed to the error-function that does i18n and sprintf. More...

Variables
trait	DeriveApplyToFromTransform
trait	DeriveInvokeFromTransform
trait	DeriveTransformFromApplyTo
trait	ProblemBuilder

Detailed Description

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Function Documentation

__invoke()

ILIAS\Refinery\__invoke

(

$from

)

Exceptions

Definition at line 26 of file DeriveInvokeFromTransform.php.

    {
        return $this->transform($from);
    }

applyTo()

ILIAS\Refinery\applyTo

(

Result

$result

)

Parameters

Result

$result

Returns

Result

Definition at line 25 of file DeriveApplyToFromTransform.php.

References ILIAS\Data\Result\value().

Referenced by ILIAS\UI\Implementation\Component\Input\Field\Tag\isClientSideValueOk().

                                            : Result
    {
        try {
            $value = $this->transform($result->value());
        } catch (\Exception $exception) {
            return new Result\Error($exception);
        }

        return new Result\Ok($value);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getErrorMessage()

ILIAS\Refinery\getErrorMessage (   $value )

final

Get the problem message.

Returns

string

Definition at line 31 of file ProblemBuilder.php.

References ILIAS\Refinery\getLngClosure().

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

    {
        $error = $this->getError();
        if (!is_callable($error)) {
            return (string) $error;
        }
        $lng_closure = $this->getLngClosure();
        return call_user_func($this->error, $lng_closure, $value);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLngClosure()

ILIAS\Refinery\getLngClosure ( )

finalprotected

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

Returns

Definition at line 47 of file ProblemBuilder.php.

References $i.

Referenced by MyValidationConstraintsConstraint\_getLngClosure(), and ILIAS\Refinery\getErrorMessage().

    {
        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;
        };
    }

Here is the caller graph for this function:

withProblemBuilder()

ILIAS\Refinery\withProblemBuilder ( callable  $builder )

final

Definition at line 19 of file ProblemBuilder.php.

References $builder.

Referenced by ILIAS\UI\Implementation\Component\Input\Field\Tag\getConstraintForRequirement().

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

Here is the caller graph for this function:

Variable Documentation

DeriveApplyToFromTransform

trait ILIAS::Refinery\DeriveApplyToFromTransform

Initial value:

{
    
    abstract public function transform($from)

Definition at line 13 of file DeriveApplyToFromTransform.php.

DeriveInvokeFromTransform

trait ILIAS::Refinery\DeriveInvokeFromTransform

Initial value:

{
    
    abstract public function transform($from)

Definition at line 13 of file DeriveInvokeFromTransform.php.

DeriveTransformFromApplyTo

trait ILIAS::Refinery\DeriveTransformFromApplyTo

Initial value:

{
    
    abstract public function applyTo(Result $result) : Result

Definition at line 13 of file DeriveTransformFromApplyTo.php.

ProblemBuilder

trait ILIAS::Refinery\ProblemBuilder

Initial value:

{
    
    abstract protected function getError()

Definition at line 10 of file ProblemBuilder.php.