ILIAS\Refinery Namespace Reference

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

Functions
	applyTo (Result $result)
	__invoke ($from)
	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

)

Definition at line 33 of file DeriveInvokeFromTransform.php.

References ILIAS\Refinery\transform().

Referenced by ilInitialisation\getClientIdTransformation().

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

Here is the call graph for this function:

Here is the caller graph for this function:

applyTo()

ILIAS\Refinery\applyTo

(

Result

$result

)

Definition at line 38 of file DeriveApplyToFromTransform.php.

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

Referenced by ilInitialisation\getClientIdTransformation(), ILIAS\UI\Implementation\Component\Input\Field\Tag\isClientSideValueOk(), ILIAS\Tests\Refinery\IdentityTransformationTest\testApplyToError(), and ILIAS\Tests\Refinery\IdentityTransformationTest\testApplyToOk().

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

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.

References ILIAS\Refinery\getErrorMessage().

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

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

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.

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

Referenced by ILIAS\Refinery\check(), ILIAS\Refinery\To\Transformation\StringTransformation\check(), ILIAS\Refinery\To\Transformation\BooleanTransformation\check(), ILIAS\Refinery\To\Transformation\FloatTransformation\check(), ILIAS\Refinery\To\Transformation\IntegerTransformation\check(), ILIAS\Refinery\To\Transformation\DateTimeTransformation\check(), ILIAS\Refinery\To\Transformation\ListTransformation\check(), ILIAS\Refinery\To\Transformation\DictionaryTransformation\check(), ILIAS\AdvancedMetaData\Services\ObjectModes\Custom\Custom\Constraint\check(), ILIAS\Refinery\To\Transformation\TupleTransformation\check(), ILIAS\Refinery\To\Transformation\RecordTransformation\check(), ILIAS\Refinery\problemWith(), ILIAS\Refinery\To\Transformation\IntegerTransformation\problemWith(), ILIAS\Refinery\To\Transformation\BooleanTransformation\problemWith(), ILIAS\Refinery\To\Transformation\StringTransformation\problemWith(), ILIAS\Refinery\To\Transformation\FloatTransformation\problemWith(), ILIAS\Refinery\To\Transformation\DateTimeTransformation\problemWith(), ILIAS\Refinery\To\Transformation\ListTransformation\problemWith(), ILIAS\AdvancedMetaData\Services\ObjectModes\Custom\Custom\Constraint\problemWith(), ILIAS\Refinery\To\Transformation\DictionaryTransformation\problemWith(), ILIAS\Refinery\To\Transformation\TupleTransformation\problemWith(), ILIAS\Refinery\To\Transformation\RecordTransformation\problemWith(), ilObjPrivacySecurityGUI\save_privacy(), and ILIAS\Refinery\ByTrying\transform().

                                                 : string
    {
        $error = $this->getError();
        if (!is_callable($error)) {
            return $error;
        }
        $lng_closure = $this->getLngClosure();
        return $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.

Definition at line 52 of file ProblemBuilder.php.

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

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

                                            : 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));
        };
    }

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.

References ILIAS\Refinery\getErrorMessage(), and null.

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

        return null;
    }

Here is the call graph for this function:

transform()

ILIAS\Refinery\transform

(

$from

)

Definition at line 36 of file DeriveTransformWithProblem.php.

References ILIAS\Refinery\check().

Referenced by ILIAS\Refinery\Parser\ABNF\Brick\__construct(), ilObjectServiceSettingsGUI\__construct(), ilLDAPSettingsGUI\__construct(), ILIAS\Refinery\__invoke(), ILIAS\Refinery\applyTo(), ilObjectGUI\buildRefIdsFromData(), ilMailSearchObjectGUI\cancel(), ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\checkPointsInput(), ilMailTemplateGUI\confirmDeleteTemplate(), ilRegistrationSettingsGUI\deleteConfirmation(), ilRegistrationSettingsGUI\exportCodes(), ILIAS\Test\Scoring\Manual\TestScoringByQuestionGUI\getAnswerDetail(), ilInitialisation\getClientIdTransformation(), ILIAS\TestQuestionPool\RequestDataCollector\getMatchingPairs(), ilObjUserFolderGUI\importUsersObject(), ilMailExplorer\initFolder(), ilMailGUI\initFolder(), ilMailFolderGUI\initRequest(), ilChatroomViewGUI\lostConnection(), ILIAS\Refinery\Parser\ABNF\Brick\namesFromKeys(), ilMailCronOrphanedMails\saveCustomSettings(), ilForumCronNotification\saveCustomSettings(), ILIAS\ILIASObject\Properties\MultiPropertiesManipulator\saveEditAvailabilityPeriodPropertiesModal(), ILIAS\Test\Scoring\Manual\TestScoringByQuestionGUI\saveManScoringByQuestion(), ILIAS\Test\Scoring\Manual\TestScoringByParticipantGUI\saveManScoringParticipantScreen(), ilObjectCopyGUI\setSource(), ilObjectCopyGUI\setTargets(), ilMailFormGUI\showForm(), ILIAS\Tests\Refinery\Encode\Transformation\URLTest\testInvalidEncoding(), ILIAS\Tests\Refinery\Encode\Transformation\JsonTest\testInvalidEncoding(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLAttributeValueTest\testInvalidEncoding(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLSpecialCharsAsEntitiesTest\testInvalidEncoding(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLSpecialCharsAsEntitiesTest\testInvalidType(), ILIAS\Tests\Refinery\Encode\Transformation\URLTest\testInvalidType(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLAttributeValueTest\testInvalidType(), ILIAS\Tests\Refinery\ConstantTransformationTest\testTransform(), ILIAS\Tests\Refinery\IdentityTransformationTest\testTransform(), ILIAS\Tests\Refinery\Encode\Transformation\URLTest\testTransform(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLSpecialCharsAsEntitiesTest\testTransform(), ILIAS\Tests\Refinery\Encode\Transformation\JsonTest\testTransform(), ILIAS\Tests\Refinery\Encode\Transformation\HTMLAttributeValueTest\testTransform(), ILIAS\Tests\Refinery\Random\Transformation\ShuffleTransformationTest\testTransformResultFailure(), ILIAS\Tests\Refinery\Random\Transformation\ShuffleTransformationTest\testTransformResultSuccess(), assFormulaQuestionResult\transformAnswerValueAccordingToType(), ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\transformArray(), ILIAS\Refinery\Parser\ABNF\Brick\transformation(), and ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\transformPoints().

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

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.

Referenced by ILIAS\UI\Implementation\Component\Input\Field\Radio\getConstraintForRequirement(), ILIAS\UI\Implementation\Component\Input\Field\TreeSelect\getConstraintForRequirement(), ILIAS\UI\Implementation\Component\Input\Field\Select\getConstraintForRequirement(), ILIAS\UI\Implementation\Component\Input\Field\Tag\getConstraintForRequirement(), and ILIAS\UI\Implementation\Component\Input\Field\DateTime\getConstraintForRequirement().

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

Here is the caller graph for this function: