ILIAS\FileUpload\Activities\Parameter Class Reference

Reads the raw parameters of an activity strictly, with the Refinery. More...

Collaboration diagram for ILIAS\FileUpload\Activities\Parameter:

Public Member Functions
	__construct (private readonly Refinery $refinery,)
	id (array $raw_parameters, string $name, string $missing)
	A positive whole number, e.g. More...
	string (array $raw_parameters, string $name)
	A plain value as it was sent, trimmed; null if it was not sent. More...
	text (array $raw_parameters, string $name)
	Text a user wrote, e.g. More...
	flag (array $raw_parameters, string $name, bool $default)
	A yes or a no: true, false, 1, 0, also as text. More...
	list (array $raw_parameters, string $name)
	A list of plain values, sent as a list or comma separated; empty entries are dropped. More...

Private Member Functions
	toString ()
	Text, or a number sent as one - a JSON body may well carry a title 42. More...
	trim ()
	apply (Transformation $transformation, mixed $value, string $refusal)
	The Refinery says why in its own words and in its own exceptions; the caller is told which parameter was wrong, as a 400. More...

Detailed Description

Reads the raw parameters of an activity strictly, with the Refinery.

Raw parameters come from outside - a query string, a JSON body - and a cast makes something of everything: ‘(int) ['5’]is 1, the root of the repository,(int) '102abc'is 102.kindlyTo()` is the right tool for values that arrive as text, but it is kind to more than text: it makes 1 of true and rounds 1.7. So every parameter first has to be of a type that can carry it (to()), and only then is it converted (kindlyTo()). A value that is not what the parameter takes is refused with a 400, so a client never gets an answer to a question it did not ask.

Once maybePerformAs() reads raw parameters through the input description of an activity, this goes away.

Definition at line 41 of file Parameter.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\Activities\Parameter::__construct

(

private readonly Refinery

$refinery

)

Definition at line 43 of file Parameter.php.

      {
    }

Member Function Documentation

apply()

ILIAS\FileUpload\Activities\Parameter::apply ( Transformation  $transformation, mixed  $value, string  $refusal  )

private

The Refinery says why in its own words and in its own exceptions; the caller is told which parameter was wrong, as a 400.

Definition at line 202 of file Parameter.php.

                                                                                         : mixed
    {
        try {
            return $transformation->transform($value);
        } catch (\Exception $e) {
            throw new \InvalidArgumentException($refusal, 400, $e);
        }
    }

References Vendor\Package\$e, and ILIAS\Refinery\Transformation\transform().

Referenced by ILIAS\FileUpload\Activities\Parameter\flag(), ILIAS\FileUpload\Activities\Parameter\id(), ILIAS\FileUpload\Activities\Parameter\list(), ILIAS\FileUpload\Activities\Parameter\string(), and ILIAS\FileUpload\Activities\Parameter\text().

Here is the call graph for this function:

Here is the caller graph for this function:

flag()

ILIAS\FileUpload\Activities\Parameter::flag	(	array	$raw_parameters,
		string	$name,
		bool	$default
	)

A yes or a no: true, false, 1, 0, also as text.

Anything else is refused rather than read as "no" - for keep_previous_version a typo would be "drop the history". Only a missing value falls back to the default.

Parameters

array<string,mixed>

$raw_parameters

Definition at line 125 of file Parameter.php.

                                                                            : bool
    {
        $value = $raw_parameters[$name] ?? null;
 
        if ($value === null) {
            return $default;
        }
 
        return $this->apply(
            $this->refinery->kindlyTo()->bool(),
            $value,
            "'{$name}' has to be true or false."
        );
    }

References ILIAS\FileUpload\Activities\Parameter\apply(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

id()

ILIAS\FileUpload\Activities\Parameter::id	(	array	$raw_parameters,
		string	$name,
		string	$missing
	)

A positive whole number, e.g.

a reference id.

Parameters

	array<string,mixed>	$raw_parameters
string	$missing	what to answer when the parameter is not there

Definition at line 54 of file Parameter.php.

                                                                            : int
    {
        $value = $raw_parameters[$name] ?? null;
 
        if ($value === null || $value === '') {
            throw new \InvalidArgumentException($missing, 400);
        }
 
        return $this->apply(
            $this->refinery->in()->series([
                $this->refinery->byTrying([
                    $this->refinery->to()->int(),
                    $this->refinery->to()->string(),
                ]),
                $this->refinery->kindlyTo()->int(),
                $this->refinery->int()->isGreaterThan(0),
            ]),
            $value,
            "'{$name}' has to be a positive whole number."
        );
    }

References ILIAS\FileUpload\Activities\Parameter\apply(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

list()

ILIAS\FileUpload\Activities\Parameter::list	(	array	$raw_parameters,
		string	$name
	)

A list of plain values, sent as a list or comma separated; empty entries are dropped.

Parameters

array<string,mixed>

$raw_parameters

Returns

list<string>

Definition at line 148 of file Parameter.php.

                                                             : array
    {
        $value = $raw_parameters[$name] ?? [];
 
        $list = $this->apply(
            $this->refinery->in()->series([
                $this->refinery->byTrying([
                    $this->refinery->in()->series([
                        $this->refinery->to()->string(),
                        $this->refinery->string()->splitString(','),
                    ]),
                    $this->refinery->identity(),
                ]),
                $this->refinery->to()->listOf(
                    $this->refinery->in()->series([
                        $this->refinery->to()->string(),
                        $this->trim(),
                    ])
                ),
            ]),
            $value,
            "'{$name}' has to be a list of texts."
        );
 
        return array_values(array_filter($list, static fn(string $entry): bool => $entry !== ''));
    }

References ILIAS\FileUpload\Activities\Parameter\apply(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

string()

ILIAS\FileUpload\Activities\Parameter::string	(	array	$raw_parameters,
		string	$name
	)

A plain value as it was sent, trimmed; null if it was not sent.

Parameters

array<string,mixed>

$raw_parameters

Definition at line 81 of file Parameter.php.

                                                               : ?string
    {
        $value = $raw_parameters[$name] ?? null;
 
        if ($value === null) {
            return null;
        }
 
        return $this->apply($this->toString(), $value, "'{$name}' has to be a text.");
    }

References ILIAS\FileUpload\Activities\Parameter\apply(), and ILIAS\FileUpload\Activities\Parameter\toString().

Here is the call graph for this function:

text()

ILIAS\FileUpload\Activities\Parameter::text	(	array	$raw_parameters,
		string	$name
	)

Text a user wrote, e.g.

a title: tags are stripped, as the fields of the UI framework do. Null if it was not sent.

Parameters

array<string,mixed>

$raw_parameters

Definition at line 98 of file Parameter.php.

                                                             : ?string
    {
        $value = $raw_parameters[$name] ?? null;
 
        if ($value === null) {
            return null;
        }
 
        return $this->apply(
            $this->refinery->in()->series([
                $this->toString(),
                $this->refinery->string()->stripTags(),
                $this->trim(),
            ]),
            $value,
            "'{$name}' has to be a text."
        );
    }

References ILIAS\FileUpload\Activities\Parameter\apply(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

toString()

ILIAS\FileUpload\Activities\Parameter::toString ( )

private

Text, or a number sent as one - a JSON body may well carry a title 42.

Definition at line 178 of file Parameter.php.

                               : Transformation
    {
        return $this->refinery->in()->series([
            $this->refinery->byTrying([
                $this->refinery->to()->string(),
                $this->refinery->to()->int(),
                $this->refinery->to()->float(),
            ]),
            $this->refinery->kindlyTo()->string(),
            $this->trim(),
        ]);
    }

References ILIAS\Repository\refinery().

Referenced by ILIAS\FileUpload\Activities\Parameter\string().

Here is the call graph for this function:

Here is the caller graph for this function:

trim()

ILIAS\FileUpload\Activities\Parameter::trim ( )

private

Definition at line 191 of file Parameter.php.

                           : Transformation
    {
        return $this->refinery->custom()->transformation(
            static fn(string $value): string => trim($value)
        );
    }

References ILIAS\Repository\refinery(), and ILIAS\FileUpload\Activities\Parameter\trim().

Referenced by ILIAS\FileUpload\Activities\Parameter\trim().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/FileUpload/src/Activities/Parameter.php