RequestDataCollector.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Test;

use ILIAS\HTTP\Services as HTTPServices;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Refinery\Transformation;
use ILIAS\Repository\BaseGUIRequest;
use Psr\Http\Message\ServerRequestInterface;

use function array_map;

class RequestDataCollector
{
    use BaseGUIRequest;

    protected array $params;

    public function __construct(
        HTTPServices $http,
        Refinery $refinery
    ) {
        $this->initRequest($http, $refinery);
    }

    public function getRequest(): ServerRequestInterface
    {
        return $this->http->request();
    }

    public function isset(string $key): bool
    {
        return $this->raw($key) !== null;
    }

    public function hasRefId(): bool
    {
        return $this->raw('ref_id') !== null;
    }

    public function getRefId(): int
    {
        return $this->int("ref_id");
    }

    public function getIds(): array
    {
        return $this->strArray("id");
    }

    public function hasQuestionId(): bool
    {
        return $this->raw('q_id') !== null;
    }

    public function getQuestionId(): int
    {
        return $this->int('q_id');
    }

    public function getQuestionIds(): array
    {
        return $this->intArray('q_id');
    }

    public function getNextCommand(): string
    {
        return $this->str('nextCommand');
    }

    public function getActiveId(): int
    {
        return $this->int('active_id');
    }

    public function getPassId(): int
    {
        return $this->int('pass_id');
    }

    public function retrieveBoolFromPost(string $key): ?bool
    {
        if (!$this->http->wrapper()->post()->has($key)) {
            return null;
        }

        return $this->http->wrapper()->post()->retrieve(
            $key,
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->bool(),
                $this->refinery->always(null)
            ])
        );
    }

    public function isInstanceResponseRequested(): bool
    {
        if (!$this->http->wrapper()->query()->has('instresp')) {
            return false;
        }

        return $this->http->wrapper()->query()->retrieve(
            'instresp',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->bool(),
                $this->refinery->always(false)
            ])
        );
    }

    public function raw(string $key): mixed
    {
        return $this->get($key, $this->refinery->identity());
    }

    public function strVal(string $key): string
    {
        return $this->str($key);
    }

    public function getParsedBody(): ?array
    {
        return $this->http->request()->getParsedBody();
    }

    public function getPostKeys(): array
    {
        return $this->http->wrapper()->post()->keys();
    }

    public function isPostRequest(): bool
    {
        return $this->http->request()->getMethod() === 'POST';
    }

    public function retrieveArrayOfStringsFromPost(string $key): array
    {
        return $this->retrieveArrayFromPost($key, $this->refinery->kindlyTo()->string());
    }

    public function retrieveArrayOfIntsFromPost(string $key): array
    {
        return $this->retrieveArrayFromPost($key, $this->refinery->kindlyTo()->int());
    }

    private function retrieveArrayFromPost(string $key, Transformation $transformation): array
    {
        return $this->http->wrapper()->post()->retrieve(
            $key,
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($transformation),
                $this->refinery->always([])
            ])
        );
    }

    public function getMultiSelectionIds(string $key): array|string
    {
        $p = $this->http->wrapper()->query();
        $r = $this->refinery;

        if (!$p->has($key)) {
            return [];
        }

        return $p->retrieve(
            $key,
            $r->custom()->transformation(function ($value) {
                return $value === 'ALL_OBJECTS' || $value[0] === 'ALL_OBJECTS' ? 'ALL_OBJECTS' : array_map('intval', $value);
            })
        );
    }
}