class.ilBadgeGUIRequest.php

Go to the documentation of this file.

<?php

use ILIAS\HTTP;
use ILIAS\Refinery;

class ilBadgeGUIRequest
{
    private const ACTION_PARAMETER_TOKEN = 'tid_id';
    private const ACTION_PARAMETER_TOKEN_ID = 'id';

    protected HTTP\Services $http;
    protected Refinery\Factory $refinery;

    public function __construct(
        HTTP\Services $http,
        Refinery\Factory $refinery
    ) {
        $this->initRequest(
            $http,
            $refinery
        );
    }

    protected function initRequest(
        HTTP\Services $http,
        Refinery\Factory $refinery
    ): void {
        $this->http = $http;
        $this->refinery = $refinery;
    }

    // get string parameter kindly
    protected function str(string $key): string
    {
        $t = $this->refinery->kindlyTo()->string();
        return \ilUtil::stripSlashes((string) ($this->get($key, $t) ?? ""));
    }

    // get integer parameter kindly
    protected function int(string $key): int
    {
        $t = $this->refinery->kindlyTo()->int();
        return (int) ($this->get($key, $t) ?? 0);
    }

    // get integer array kindly
    protected function intArray(string $key): array
    {
        if (!$this->isArray($key)) {
            return [];
        }
        $t = $this->refinery->custom()->transformation(
            static function (array $arr): array {
                // keep keys(!), transform all values to int
                return array_column(
                    array_map(
                        static function ($k, $v): array {
                            return [$k, (int) $v];
                        },
                        array_keys($arr),
                        $arr
                    ),
                    1,
                    0
                );
            }
        );
        return (array) ($this->get($key, $t) ?? []);
    }

    // get string array kindly
    protected function strArray($key): array
    {
        if (!$this->isArray($key)) {
            return [];
        }
        $t = $this->refinery->custom()->transformation(
            function ($arr) {
                // keep keys(!), transform all values to string
                return array_column(
                    array_map(
                        function ($k, $v) {
                            if (is_array($v)) {
                                $v = "";
                            }
                            return [$k, \ilUtil::stripSlashes((string) $v)];
                        },
                        array_keys($arr),
                        $arr
                    ),
                    1,
                    0
                );
            }
        );
        return (array) ($this->get($key, $t) ?? []);
    }

    protected function isArray(string $key): bool
    {
        $no_transform = $this->refinery->identity();
        $w = $this->http->wrapper();
        if ($w->post()->has($key)) {
            return is_array($w->post()->retrieve($key, $no_transform));
        }
        if ($w->query()->has($key)) {
            return is_array($w->query()->retrieve($key, $no_transform));
        }
        return false;
    }

    protected function get(string $key, Refinery\Transformation $t)
    {
        $w = $this->http->wrapper();
        if ($w->post()->has($key)) {
            return $w->post()->retrieve($key, $t);
        }
        if ($w->query()->has($key)) {
            return $w->query()->retrieve($key, $t);
        }
        return null;
    }

    public function getBadgeIds(): array
    {
        $badge_ids = $this->intArray("badge_id");
        if (count($badge_ids) === 0 && $this->int("badge_id") > 0) {
            $badge_ids = [$this->int("badge_id")];
        }
        return $badge_ids;
    }

    public function getBadgeIdFromUrl(): int
    {
        $id = 0;
        $query = $this->http->wrapper()->query();
        if ($query->has(self::ACTION_PARAMETER_TOKEN)) {
            $tmpl_ids = $query->retrieve(
                self::ACTION_PARAMETER_TOKEN,
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
            );
            if (count($tmpl_ids) === 1) {
                $id = (int) array_pop($tmpl_ids);
            }
        }

        return $id;
    }

    public function getMultiActionBadgeIdsFromUrl(): array
    {
        $tmpl_ids = [];
        $query = $this->http->wrapper()->query();
        if ($query->has(self::ACTION_PARAMETER_TOKEN)) {
            $tmpl_ids = $query->retrieve(
                self::ACTION_PARAMETER_TOKEN,
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
            );
        }

        return $tmpl_ids;
    }

    public function getMultiActionBadgeIdsFromPost(): array
    {
        $tmpl_ids = [];
        $query = $this->http->wrapper()->post();
        if ($query->has(self::ACTION_PARAMETER_TOKEN_ID)) {
            $tmpl_ids = $query->retrieve(
                self::ACTION_PARAMETER_TOKEN_ID,
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
            );
        }

        return $tmpl_ids;
    }


    public function getBadgeId(): int
    {
        return $this->int("bid");
    }

    public function getId(): int
    {
        return $this->int("id");
    }

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

    public function getType(): string
    {
        return $this->str("type");
    }

    public function getTgt(): string
    {
        return $this->str("tgt");
    }

    public function getTemplateId(): int
    {
        return $this->int("tid");
    }

    public function getParentId(): int
    {
        return $this->int("pid");
    }

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