ILIAS\Refinery Namespace Reference

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

Data Structures
class	ByTrying
class	ConstantTransformation
interface	Constraint
	A constraint encodes some resrtictions on values. More...
class	ConstraintViolationException
class	Factory
class	FactoryFactory
	This Javaism is required to solve the problem that we do not have proper \ILIAS\Language\Language during the setup. More...
class	IdentityTransformation
class	IsExecutableTransformation
	Validates that the given string is a valid and executable file path. More...
class	IsNull
class	KeyValueAccess
interface	Transformation
	A transformation is a function from one datatype to another. More...

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

Function Documentation

__invoke()

ILIAS\Refinery\__invoke

(

$from

)

@inheritDoc

Definition at line 33 of file DeriveInvokeFromTransform.php.

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

References ILIAS\Refinery\transform().

Referenced by ilInitialisation\getClientIdTransformation().

Here is the call graph for this function:

Here is the caller graph for this function:

applyTo()

ILIAS\Refinery\applyTo

(

Result

$result

)

@inheritDoc

Definition at line 38 of file DeriveApplyToFromTransform.php.

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

References ILIAS\Data\Result\then(), and ILIAS\Refinery\transform().

Referenced by ilInitialisation\getClientIdTransformation(), ILIAS\Tests\Refinery\IdentityTransformationTest\testApplyToError(), and ILIAS\Tests\Refinery\IdentityTransformationTest\testApplyToOk().

Here is the call graph for this function:

Here is the caller graph for this function:

check()

ILIAS\Refinery\check

(

$value

)

Definition at line 42 of file DeriveTransformWithProblem.php.

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

References ILIAS\Refinery\getErrorMessage().

Referenced by ILIAS\ResourceStorage\Policy\FileNamePolicyTest\getFileNamePolicy(), and ILIAS\Refinery\transform().

Here is the call graph for this function:

Here is the caller graph for this function:

getErrorMessage()

ILIAS\Refinery\getErrorMessage (   $value )

final

Definition at line 39 of file ProblemBuilder.php.

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

References ILIAS\$error, getError(), and ILIAS\Refinery\getLngClosure().

Referenced by assTextQuestionGUI\addSuggestedSolution(), ILIAS\Refinery\Custom\Constraint\check(), ILIAS\Refinery\check(), ILIAS\Refinery\To\Transformation\BooleanTransformation\check(), ILIAS\Refinery\To\Transformation\DateTimeTransformation\check(), ILIAS\Refinery\To\Transformation\DictionaryTransformation\check(), ILIAS\Refinery\To\Transformation\FloatTransformation\check(), ILIAS\Refinery\To\Transformation\IntegerTransformation\check(), ILIAS\Refinery\To\Transformation\ListTransformation\check(), ILIAS\Refinery\To\Transformation\RecordTransformation\check(), ILIAS\Refinery\To\Transformation\StringTransformation\check(), ILIAS\Refinery\To\Transformation\TupleTransformation\check(), ILIAS\Refinery\Custom\Constraint\problemWith(), ILIAS\Refinery\problemWith(), ILIAS\Refinery\To\Transformation\BooleanTransformation\problemWith(), ILIAS\Refinery\To\Transformation\DateTimeTransformation\problemWith(), ILIAS\Refinery\To\Transformation\DictionaryTransformation\problemWith(), ILIAS\Refinery\To\Transformation\FloatTransformation\problemWith(), ILIAS\Refinery\To\Transformation\IntegerTransformation\problemWith(), ILIAS\Refinery\To\Transformation\ListTransformation\problemWith(), ILIAS\Refinery\To\Transformation\RecordTransformation\problemWith(), ILIAS\Refinery\To\Transformation\StringTransformation\problemWith(), ILIAS\Refinery\To\Transformation\TupleTransformation\problemWith(), and ILIAS\Refinery\ByTrying\transform().

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.

Definition at line 52 of file ProblemBuilder.php.

                                            : Closure
    {
        return function (string $lang_var, ...$args): string {
            $error = $this->lng->txt($lang_var);
 
            if ($args === []) {
                return $error;
            }
 
            return sprintf($error, ...array_map(function ($v) {
                if (is_array($v)) {
                    return "array";
                } elseif (is_null($v)) {
                    return "null";
                } elseif (is_object($v) && !method_exists($v, "__toString")) {
                    return get_class($v);
                }
                return $v;
            }, $args));
        };
    }

References ILIAS\$error, and ILIAS\Repository\lng().

Referenced by ILIAS\Refinery\getErrorMessage(), and CustomTest\setUp().

Here is the call graph for this function:

Here is the caller graph for this function:

problemWith()

ILIAS\Refinery\problemWith

(

$value

)

Definition at line 49 of file DeriveTransformWithProblem.php.

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

References ILIAS\Refinery\getErrorMessage().

Here is the call graph for this function:

transform()

ILIAS\Refinery\transform

(

$from

)

Definition at line 36 of file DeriveTransformWithProblem.php.

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

References ILIAS\Refinery\check().

Referenced by ILIAS\Refinery\Parser\ABNF\Brick\__construct(), ILIAS\Refinery\__invoke(), ILIAS\Refinery\applyTo(), ilObjTestGUI\buildInputPoolSelection(), ilMailSearchObjectMembershipsTableGUI\fillRow(), ilInitialisation\getClientIdTransformation(), ILIAS\Refinery\Parser\ABNF\Brick\namesFromKeys(), ILIAS\Test\Questions\Presentation\QuestionsTableQuery\retrieveStringOrNull(), ilMailCronOrphanedMails\saveCustomSettings(), ILIAS\User\Profile\PersonalProfileGUI\showPublicProfileFields(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLAttributeValueTest\testInvalidEncoding(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLSpecialCharsAsEntitiesTest\testInvalidEncoding(), ILIAS\Tests\Refinery\Encode\Transformation\JsonTest\testInvalidEncoding(), ILIAS\Tests\Refinery\Encode\Transformation\URLTest\testInvalidEncoding(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLAttributeValueTest\testInvalidType(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLSpecialCharsAsEntitiesTest\testInvalidType(), ILIAS\Tests\Refinery\Encode\Transformation\URLTest\testInvalidType(), ILIAS\Tests\Refinery\ConstantTransformationTest\testTransform(), ILIAS\Tests\Refinery\IdentityTransformationTest\testTransform(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLSpecialCharsAsEntitiesTest\testTransform(), ILIAS\Tests\Refinery\Encode\Transformation\URLTest\testTransform(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLAttributeValueTest\testTransform(), ILIAS\Tests\Refinery\Encode\Transformation\JsonTest\testTransform(), ILIAS\Tests\Refinery\Random\Transformation\ShuffleTransformationTest\testTransformResultFailure(), ILIAS\Tests\Refinery\Random\Transformation\ShuffleTransformationTest\testTransformResultSuccess(), assMatchingQuestion\toJSON(), and ILIAS\Refinery\Parser\ABNF\Brick\transformation().

Here is the call graph for this function:

Here is the caller graph for this function:

withProblemBuilder()

ILIAS\Refinery\withProblemBuilder ( callable  $builder )

final

Definition at line 32 of file ProblemBuilder.php.

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