ilBadgeGUIRequest Class Reference

Collaboration diagram for ilBadgeGUIRequest:

Public Member Functions
	__construct (HTTP\Services $http, Refinery\Factory $refinery)
	getBadgeIds ()
	getBadgeIdFromUrl ()
	getMultiActionBadgeIdsFromUrl ()
	getMultiActionBadgeIdsFromPost ()
	getBadgeId ()
	getId ()
	getIds ()
	getType ()
	getTgt ()
	getTemplateId ()
	getParentId ()
	getBadgeAssignableUsers ()

Protected Member Functions
	initRequest (HTTP\Services $http, Refinery\Factory $refinery)
	str (string $key)
	int (string $key)
	intArray (string $key)
	strArray ($key)
	isArray (string $key)
	Check if parameter is an array. More...
	get (string $key, Refinery\Transformation $t)

Protected Attributes
HTTP Services	$http
Refinery Factory	$refinery

Private Attributes
const	ACTION_PARAMETER_TOKEN = 'tid_id'
const	ACTION_PARAMETER_TOKEN_ID = 'id'

Detailed Description

Definition at line 22 of file class.ilBadgeGUIRequest.php.

Constructor & Destructor Documentation

__construct()

ilBadgeGUIRequest::__construct	(	HTTP\Services	$http,
		Refinery\Factory	$refinery
	)

Definition at line 30 of file class.ilBadgeGUIRequest.php.

References initRequest().

      {
        $this->initRequest(
            $http,
            $refinery
        );
    }

Here is the call graph for this function:

Member Function Documentation

get()

ilBadgeGUIRequest::get ( string  $key, Refinery\Transformation  $t  )

protected

Returns

mixed|null

Definition at line 134 of file class.ilBadgeGUIRequest.php.

References ILIAS\FileDelivery\http(), and 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);
        }
        return null;
    }

Here is the call graph for this function:

getBadgeAssignableUsers()

ilBadgeGUIRequest::getBadgeAssignableUsers

(

)

Definition at line 244 of file class.ilBadgeGUIRequest.php.

References strArray().

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

Here is the call graph for this function:

getBadgeId()

ilBadgeGUIRequest::getBadgeId

(

)

Definition at line 208 of file class.ilBadgeGUIRequest.php.

References int().

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

Here is the call graph for this function:

getBadgeIdFromUrl()

ilBadgeGUIRequest::getBadgeIdFromUrl

(

)

Definition at line 156 of file class.ilBadgeGUIRequest.php.

References $id, ILIAS\FileDelivery\http(), int(), and ILIAS\Repository\refinery().

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

Here is the call graph for this function:

getBadgeIds()

ilBadgeGUIRequest::getBadgeIds

(

)

Returns

int []

Definition at line 147 of file class.ilBadgeGUIRequest.php.

References int(), and intArray().

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

Here is the call graph for this function:

getId()

ilBadgeGUIRequest::getId

(

)

Definition at line 213 of file class.ilBadgeGUIRequest.php.

References int().

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

Here is the call graph for this function:

getIds()

ilBadgeGUIRequest::getIds

(

)

Returns

string[]

Definition at line 219 of file class.ilBadgeGUIRequest.php.

References strArray().

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

Here is the call graph for this function:

getMultiActionBadgeIdsFromPost()

ilBadgeGUIRequest::getMultiActionBadgeIdsFromPost

(

)

Returns

list<string>

Definition at line 193 of file class.ilBadgeGUIRequest.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

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

Here is the call graph for this function:

getMultiActionBadgeIdsFromUrl()

ilBadgeGUIRequest::getMultiActionBadgeIdsFromUrl

(

)

Returns

list<string>

Definition at line 176 of file class.ilBadgeGUIRequest.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

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

Here is the call graph for this function:

getParentId()

ilBadgeGUIRequest::getParentId

(

)

Definition at line 239 of file class.ilBadgeGUIRequest.php.

References int().

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

Here is the call graph for this function:

getTemplateId()

ilBadgeGUIRequest::getTemplateId

(

)

Definition at line 234 of file class.ilBadgeGUIRequest.php.

References int().

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

Here is the call graph for this function:

getTgt()

ilBadgeGUIRequest::getTgt

(

)

Definition at line 229 of file class.ilBadgeGUIRequest.php.

References str().

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

Here is the call graph for this function:

getType()

ilBadgeGUIRequest::getType

(

)

Definition at line 224 of file class.ilBadgeGUIRequest.php.

References str().

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

Here is the call graph for this function:

initRequest()

ilBadgeGUIRequest::initRequest ( HTTP\Services  $http, Refinery\Factory  $refinery  )

protected

Definition at line 40 of file class.ilBadgeGUIRequest.php.

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

Referenced by __construct().

     : void {
        $this->http = $http;
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

int()

ilBadgeGUIRequest::int ( string  $key )

protected

Definition at line 56 of file class.ilBadgeGUIRequest.php.

References ILIAS\Repository\refinery().

Referenced by getBadgeId(), getBadgeIdFromUrl(), getBadgeIds(), getId(), getParentId(), getTemplateId(), and intArray().

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

ilBadgeGUIRequest::intArray ( string  $key )

protected

Definition at line 63 of file class.ilBadgeGUIRequest.php.

References int(), isArray(), and ILIAS\Repository\refinery().

Referenced by getBadgeIds().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isArray()

ilBadgeGUIRequest::isArray ( string  $key )

protected

Check if parameter is an array.

Definition at line 118 of file class.ilBadgeGUIRequest.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by intArray(), and strArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

str()

ilBadgeGUIRequest::str ( string  $key )

protected

Definition at line 49 of file class.ilBadgeGUIRequest.php.

References ILIAS\Repository\refinery().

Referenced by getTgt(), and getType().

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

ilBadgeGUIRequest::strArray (   $key )

protected

Definition at line 88 of file class.ilBadgeGUIRequest.php.

References isArray(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Referenced by getBadgeAssignableUsers(), and getIds().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$http

HTTP Services ilBadgeGUIRequest::$http

protected

Definition at line 27 of file class.ilBadgeGUIRequest.php.

Referenced by initRequest().

$refinery

Refinery Factory ilBadgeGUIRequest::$refinery

protected

Definition at line 28 of file class.ilBadgeGUIRequest.php.

Referenced by initRequest().

ACTION_PARAMETER_TOKEN

const ilBadgeGUIRequest::ACTION_PARAMETER_TOKEN = 'tid_id'

private

Definition at line 24 of file class.ilBadgeGUIRequest.php.

ACTION_PARAMETER_TOKEN_ID

const ilBadgeGUIRequest::ACTION_PARAMETER_TOKEN_ID = 'id'

private

Definition at line 25 of file class.ilBadgeGUIRequest.php.

---

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

• components/ILIAS/Badge/classes/class.ilBadgeGUIRequest.php