Skill gui global request wrapper. More...

Inheritance diagram for ILIAS\Skill\Service\SkillGUIRequest:

Collaboration diagram for ILIAS\Skill\Service\SkillGUIRequest:

Public Member Functions
	__construct (HTTP\Services $http, Refinery\Factory $refinery, ?array $passed_query_params=null, ?array $passed_post_data=null)
	Query params and post data parameters are used for testing. More...

Protected Member Functions
	int (string $key)
	get integer parameter kindly More...

	intArray (string $key)
	get integer array kindly More...

	str (string $key)
	get string parameter kindly More...

	strArray (string $key)
	get string array kindly More...

	bool (string $key)
	get bool parameter kindly More...

	boolArray (string $key)
	get bool array kindly More...

	isArray (string $key)
	Check if parameter is an array. More...

	get (string $key, Refinery\Transformation $t)
	Get passed parameter, if not data passed, get key from http request. More...

	getIds ()

Protected Attributes
HTTP Services	$http

Refinery Factory	$refinery

array	$passed_query_params = null

array	$passed_post_data = null

Detailed Description

Skill gui global request wrapper.

POST overwrites GET with the same name. POST/GET parameters may be passed to the class for testing purposes.

Author: Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

Definition at line 31 of file class.SkillGUIRequest.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Skill\Service\SkillGUIRequest::__construct	(	HTTP\Services	$http,
		Refinery\Factory	$refinery,
		?array	$passed_query_params = `null`,
		?array	$passed_post_data = `null`
	)

Query params and post data parameters are used for testing.

If none of these is provided the usual http service wrapper is used to determine the request data.

Reimplemented in ILIAS\Skill\Service\SkillAdminGUIRequest, and ILIAS\Skill\Service\SkillPersonalGUIRequest.

Definition at line 42 of file class.SkillGUIRequest.php.

      {
        $this->http = $http;
        $this->refinery = $refinery;
        $this->passed_query_params = $passed_query_params;
        $this->passed_post_data = $passed_post_data;
    }

References ILIAS\Skill\Service\SkillGUIRequest\$http, ILIAS\Skill\Service\SkillGUIRequest\$passed_post_data, ILIAS\Skill\Service\SkillGUIRequest\$passed_query_params, ILIAS\Skill\Service\SkillGUIRequest\$refinery, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ bool()

ILIAS\Skill\Service\SkillGUIRequest::bool ( string $key )

protected

get bool parameter kindly

Definition at line 116 of file class.SkillGUIRequest.php.

                                        : bool
    {
        $t = $this->refinery->kindlyTo()->bool();
        return (bool) ($this->get($key, $t) ?? false);
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\refinery().

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\getLocalContext(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getShowMaterialsResources(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getShowTargetLevel(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getTemplateMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boolArray()

ILIAS\Skill\Service\SkillGUIRequest::boolArray ( string $key )

protected

get bool array kindly

Returns: bool[]|array<int|string, bool>

Definition at line 126 of file class.SkillGUIRequest.php.

                                             : array
    {
        if (!$this->isArray($key)) {
            return [];
        }
        $t = $this->refinery->custom()->transformation(
            static function (array $arr): array {
                // keep keys(!), transform all values to bool
                return array_map('boolval', $arr);
            }
        );
        return (array) ($this->get($key, $t) ?? []);
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\Skill\Service\SkillGUIRequest\isArray(), and ILIAS\Repository\refinery().

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\getSuggested(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getTrigger().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get()

ILIAS\Skill\Service\SkillGUIRequest::get	(	string	$key,
		Refinery\Transformation	$t
	)

protected

Get passed parameter, if not data passed, get key from http request.

Returns: mixed|null

Definition at line 169 of file class.SkillGUIRequest.php.

    {
        if ($this->passed_query_params === null && $this->passed_post_data === null) {
            $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);
            }
        }
        if (isset($this->passed_post_data[$key])) {
            return $t->transform($this->passed_post_data[$key]);
        }
        if (isset($this->passed_query_params[$key])) {
            return $t->transform($this->passed_query_params[$key]);
        }
        return null;
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ getIds()

ILIAS\Skill\Service\SkillGUIRequest::getIds ( )

protected

Returns: int[]

Definition at line 192 of file class.SkillGUIRequest.php.

                               : array
    {
        return $this->intArray("id");
    }

References ILIAS\Skill\Service\SkillGUIRequest\intArray().

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\getLevelIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getNodeIds(), ilSkillContainerGUIRequest\getProfileIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getProfileIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getResourceIds(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getSkillIds(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getUserIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ int()

ILIAS\Skill\Service\SkillGUIRequest::int ( string $key )

protected

get integer parameter kindly

Definition at line 57 of file class.SkillGUIRequest.php.

                                       : int
    {
        $t = $this->refinery->kindlyTo()->int();
        return (int) ($this->get($key, $t) ?? 0);
    }

References ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\refinery().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intArray()

ILIAS\Skill\Service\SkillGUIRequest::intArray ( string $key )

protected

get integer array kindly

Returns: int[]|array<int|string, int>

Definition at line 67 of file class.SkillGUIRequest.php.

                                            : 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_map('intval', $arr);
            }
        );
        return (array) ($this->get($key, $t) ?? []);
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\Skill\Service\SkillGUIRequest\isArray(), and ILIAS\Repository\refinery().

Referenced by ILIAS\Skill\Service\SkillGUIRequest\getIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getOrder(), ilSkillContainerGUIRequest\getUserIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getUsers(), and ILIAS\Skill\Service\SkillPersonalGUIRequest\getWorkspaceIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isArray()

ILIAS\Skill\Service\SkillGUIRequest::isArray ( string $key )

protected

Check if parameter is an array.

Definition at line 143 of file class.SkillGUIRequest.php.

                                           : bool
    {
        if ($this->passed_query_params === null && $this->passed_post_data === null) {
            $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));
            }
        }
        if (isset($this->passed_post_data[$key])) {
            return is_array($this->passed_post_data[$key]);
        }
        if (isset($this->passed_query_params[$key])) {
            return is_array($this->passed_query_params[$key]);
        }
        return false;
    }

References ILIAS\LTI\ToolProvider\$key, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by ILIAS\Skill\Service\SkillGUIRequest\boolArray(), ILIAS\Skill\Service\SkillGUIRequest\intArray(), and ILIAS\Skill\Service\SkillGUIRequest\strArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ str()

ILIAS\Skill\Service\SkillGUIRequest::str ( string $key )

protected

get string parameter kindly

Definition at line 84 of file class.SkillGUIRequest.php.

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

References ILIAS\Repository\refinery().

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\getBackCommand(), ILIAS\Skill\Service\SkillAdminGUIRequest\getCombinedSkillId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getListMode(), ilSkillContainerGUIRequest\getSelectedSkill(), ILIAS\Skill\Service\SkillAdminGUIRequest\getSkillExpand(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getUserLogin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ strArray()

ILIAS\Skill\Service\SkillGUIRequest::strArray ( string $key )

protected

get string array kindly

Returns: string[]|array<int|string, string>

Definition at line 94 of file class.SkillGUIRequest.php.

                                            : array
    {
        if (!$this->isArray($key)) {
            return [];
        }
        $t = $this->refinery->custom()->transformation(
            static function (array $arr): array {
                // keep keys(!), transform all values to string
                return array_map(
                    static function ($v): string {
                        return \ilUtil::stripSlashes((string) $v);
                    },
                    $arr
                );
            }
        );
        return (array) ($this->get($key, $t) ?? []);
    }