Parameter.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\FileUpload\Activities;
 
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Refinery\Transformation;
 
class Parameter
{
    public function __construct(
        private readonly Refinery $refinery,
    ) {
    }
 
    public function id(array $raw_parameters, string $name, string $missing): 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."
        );
    }
 
    public function string(array $raw_parameters, string $name): ?string
    {
        $value = $raw_parameters[$name] ?? null;
 
        if ($value === null) {
            return null;
        }
 
        return $this->apply($this->toString(), $value, "'{$name}' has to be a text.");
    }
 
    public function text(array $raw_parameters, string $name): ?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."
        );
    }
 
    public function flag(array $raw_parameters, string $name, bool $default): 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."
        );
    }
 
    public function list(array $raw_parameters, string $name): 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 !== ''));
    }
 
    private function toString(): 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(),
        ]);
    }
 
    private function trim(): Transformation
    {
        return $this->refinery->custom()->transformation(
            static fn(string $value): string => trim($value)
        );
    }
 
    private function apply(Transformation $transformation, mixed $value, string $refusal): mixed
    {
        try {
            return $transformation->transform($value);
        } catch (\Exception $e) {
            throw new \InvalidArgumentException($refusal, 400, $e);
        }
    }
}