ILIAS\Skill\Service\SkillGUIRequest Class Reference

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 ()
	getTableIds (string $key)
	getTableAction (string $key)
	getInterruptiveItemIds ()

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 33 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.

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

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().

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

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 118 of file class.SkillGUIRequest.php.

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().

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

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 128 of file class.SkillGUIRequest.php.

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().

                                             : 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) ?? []);
    }

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 171 of file class.SkillGUIRequest.php.

References ILIAS\FileDelivery\http().

    {
        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;
    }

Here is the call graph for this function:

getIds()

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

protected

Returns

int[]

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

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

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\getLevelIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getNodeIds(), ILIAS\Container\Skills\SkillContainerGUIRequest\getProfileIds(), and ILIAS\Skill\Service\SkillPersonalGUIRequest\getSkillIds().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getInterruptiveItemIds()

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

protected

Returns

int[]

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

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

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\getProfileIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getResourceIds(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getUserIds().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getTableAction()

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

protected

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

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

Referenced by ILIAS\Skill\Service\SkillPersonalGUIRequest\getTableAssignMaterialsAction(), ILIAS\Skill\Service\SkillAdminGUIRequest\getTableLevelResourcesAction(), ILIAS\Skill\Service\SkillAdminGUIRequest\getTableProfileAction(), ILIAS\Skill\Service\SkillAdminGUIRequest\getTableProfileUserAssignmentAction(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getTableTreeAction().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getTableIds()

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

protected

Returns

string[]

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

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

Referenced by ILIAS\Skill\Service\SkillPersonalGUIRequest\getTableAssignMaterialsLevelIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getTableProfileIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getTableProfileUserAssignmentIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getTableRepoRefIds(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getTableTreeIds().

                                               : array
    {
        return $this->strArray($key);
    }

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 59 of file class.SkillGUIRequest.php.

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

Referenced by ILIAS\Skill\Service\SkillPersonalGUIRequest\getBasicSkillId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getLevelId(), ILIAS\Skill\Service\SkillAdminGUIRequest\getLevelId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getNodeId(), ILIAS\Skill\Service\SkillAdminGUIRequest\getNodeId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getProfileId(), ILIAS\Skill\Service\SkillAdminGUIRequest\getRefId(), ILIAS\Skill\Service\SkillAdminGUIRequest\getRootId(), ILIAS\Container\Skills\SkillContainerGUIRequest\getSelectedProfileId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getSkillId(), ILIAS\Skill\Service\SkillAdminGUIRequest\getSkillProfileId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getTableAssignMaterialsWorkspaceId(), ILIAS\Skill\Service\SkillAdminGUIRequest\getTemplatesTree(), ILIAS\Skill\Service\SkillAdminGUIRequest\getTrefId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getTrefId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getTypeOfFormation(), and ILIAS\Container\Skills\SkillContainerGUIRequest\getUserId().

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

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 69 of file class.SkillGUIRequest.php.

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

Referenced by ILIAS\Skill\Service\SkillGUIRequest\getIds(), ILIAS\Skill\Service\SkillGUIRequest\getInterruptiveItemIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getOrder(), ILIAS\Container\Skills\SkillContainerGUIRequest\getUserIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getUsers(), and ILIAS\Skill\Service\SkillPersonalGUIRequest\getWorkspaceIds().

                                            : 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) ?? []);
    }

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 145 of file class.SkillGUIRequest.php.

References 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().

                                           : 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;
    }

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 86 of file class.SkillGUIRequest.php.

References ILIAS\Repository\refinery().

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\getBackCommand(), ILIAS\Skill\Service\SkillAdminGUIRequest\getCombinedSkillId(), ILIAS\Skill\Service\SkillPersonalGUIRequest\getListMode(), ILIAS\Container\Skills\SkillContainerGUIRequest\getSelectedSkill(), ILIAS\Skill\Service\SkillAdminGUIRequest\getSkillExpand(), ILIAS\Skill\Service\SkillGUIRequest\getTableAction(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getUserLogin().

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

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 96 of file class.SkillGUIRequest.php.

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

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\getAssignedLevelIds(), ILIAS\Container\Skills\SkillContainerGUIRequest\getCombinedSkillIds(), ILIAS\Skill\Service\SkillAdminGUIRequest\getSelectedIds(), ILIAS\Skill\Service\SkillGUIRequest\getTableIds(), and ILIAS\Skill\Service\SkillAdminGUIRequest\getTitles().

                                            : 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) ?? []);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$http

HTTP Services ILIAS\Skill\Service\SkillGUIRequest::$http

protected

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

Referenced by ILIAS\Skill\Service\SkillGUIRequest\__construct().

$passed_post_data

array ILIAS\Skill\Service\SkillGUIRequest::$passed_post_data = null

protected

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

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\__construct(), ILIAS\Skill\Service\SkillPersonalGUIRequest\__construct(), ILIAS\Container\Skills\SkillContainerGUIRequest\__construct(), and ILIAS\Skill\Service\SkillGUIRequest\__construct().

$passed_query_params

array ILIAS\Skill\Service\SkillGUIRequest::$passed_query_params = null

protected

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

Referenced by ILIAS\Skill\Service\SkillAdminGUIRequest\__construct(), ILIAS\Skill\Service\SkillPersonalGUIRequest\__construct(), ILIAS\Container\Skills\SkillContainerGUIRequest\__construct(), and ILIAS\Skill\Service\SkillGUIRequest\__construct().

$refinery

Refinery Factory ILIAS\Skill\Service\SkillGUIRequest::$refinery

protected

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

Referenced by ILIAS\Skill\Service\SkillGUIRequest\__construct().

---

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

• Services/Skill/Service/classes/class.SkillGUIRequest.php