Collaboration diagram for ILIAS\GlobalScreen\GUI\Input\Input:

Public Member Functions
	__construct (private Services $http, private Refinery\Factory $refinery, private Factory $data_factory, private \ilLanguage $lng, private Flow $flow)

	getFirstFromRequest (null\|string\|URLBuilderToken\|TokenContainer $token)

	keepTokens (PonsGUI $gui)

	keep (null\|string\|URLBuilderToken\|TokenContainer $token)

	getAllFromRequest (null\|string\|URLBuilderToken\|TokenContainer $token)

	buildToken (string $namespace, string $token, ?URI $uri=null)

	request ()

	refinery ()

Data Fields
const	ALL_OBJECTS = 'ALL_OBJECTS'

Private Attributes
const	INTERRUPTIVE_ITEMS = 'interruptive_items'

Detailed Description

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 38 of file Input.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\GlobalScreen\GUI\Input\Input::__construct	(	private Services	$http,
		private Refinery\Factory	$refinery,
		private Factory	$data_factory,
		private \ilLanguage	$lng,
		private Flow	$flow
	)

Definition at line 51 of file Input.php.

57 {

58 }

Member Function Documentation

◆ buildToken()

ILIAS\GlobalScreen\GUI\Input\Input::buildToken	(	string	$namespace,
		string	$token,
		?URI	$uri = `null`
	)

Definition at line 144 of file Input.php.

                                                                                  : TokenContainer
    {
        if ($uri === null) {
            $uri = $this->flow->getHereAsURI();
        }
 
        $builder = new URLBuilder($uri);
 
        return new TokenContainer(...$builder->acquireParameter([$namespace], $token));
    }

References $namespace, and $token.

◆ getAllFromRequest()

ILIAS\GlobalScreen\GUI\Input\Input::getAllFromRequest ( null|string|URLBuilderToken|TokenContainer $token )

Definition at line 106 of file Input.php.

     : array {
        if ($token === null) {
            return [];
        }
 
        if ($token instanceof TokenContainer) {
            $token = $token->token();
        }
 
        $query_params = $this->request()->getQueryParams(); // aka $_GET
        $name = $token instanceof URLBuilderToken ? $token->getName() : $token;
        $ids = $query_params[$name] ?? []; // array of field ids
        $ids = is_array($ids) ? $ids : [$ids];
 
        // all objects
        if (($ids[0] ?? null) === self::ALL_OBJECTS) {
            return [self::ALL_OBJECTS]; // currently we cannot support all
        }
 
        // check interruptive items
        if (($interruptive_items = $this->http->request()->getParsedBody()[self::INTERRUPTIVE_ITEMS] ?? false)) {
            foreach ($interruptive_items as $interruptive_item) {
                $ids[] = $interruptive_item;
            }
        }
        $return_ids = [];
        foreach ($ids as $id) {
            try {
                $return_ids[] = $this->unhash($id);
            } catch (\Throwable $e) {
                // skip invalid ids
            }
        }
        return $return_ids;
    }

◆ getFirstFromRequest()

ILIAS\GlobalScreen\GUI\Input\Input::getFirstFromRequest ( null|string|URLBuilderToken|TokenContainer $token )

Definition at line 60 of file Input.php.

     : string {
        if ($token === null) {
            return '';
        }
 
        if ($token instanceof TokenContainer) {
            $token = $token->token();
        }
 
        $query_params = $this->request()->getQueryParams(); // aka $_GET
        $name = $token instanceof URLBuilderToken ? $token->getName() : $token;
        $id = $query_params[$name] ?? ''; // field id
 
        if (is_array($id) && count($id) === 1 && isset($id[0]) && $id[0] === self::ALL_OBJECTS) {
            return self::ALL_OBJECTS; // special case for all objects
        }
 
        if (is_array($id)) {
            $id = $id[0] ?? null;
            return $id === null ? '' : $this->unhash($id);
        }
 
        return $this->unhash($id);
    }

◆ keep()

ILIAS\GlobalScreen\GUI\Input\Input::keep ( null|string|URLBuilderToken|TokenContainer $token )

Definition at line 94 of file Input.php.

     : void {
        if ($token instanceof TokenContainer) {
            $token = $token->token();
        }
        $ctrl = $this->flow->ctrl();
        $current_class = $ctrl->getCmdClass();
        $name = $token instanceof URLBuilderToken ? $token->getName() : $token;
        $ctrl->setParameterByClass($current_class, $name, $this->hash($this->getFirstFromRequest($token)));
    }

References $token.

Referenced by ILIAS\GlobalScreen\GUI\Input\Input\keepTokens().

Here is the caller graph for this function:

◆ keepTokens()

ILIAS\GlobalScreen\GUI\Input\Input::keepTokens ( PonsGUI $gui )

Definition at line 87 of file Input.php.

                                            : void
    {
        foreach ($gui->getTokensToKeep() as $token) {
            $this->keep($token);
        }
    }

References $token, ILIAS\GlobalScreen\GUI\PonsGUI\getTokensToKeep(), and ILIAS\GlobalScreen\GUI\Input\Input\keep().

Here is the call graph for this function:

◆ refinery()

ILIAS\GlobalScreen\GUI\Input\Input::refinery ( )

Definition at line 160 of file Input.php.

                              : Refinery\Factory
    {
        return $this->refinery;
    }

References ILIAS\UI\examples\Layout\Page\Mail\$refinery.

◆ request()

ILIAS\GlobalScreen\GUI\Input\Input::request ( )

Definition at line 155 of file Input.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

Field Documentation

◆ ALL_OBJECTS

const ILIAS\GlobalScreen\GUI\Input\Input::ALL_OBJECTS = 'ALL_OBJECTS'

Definition at line 45 of file Input.php.

◆ INTERRUPTIVE_ITEMS

const ILIAS\GlobalScreen\GUI\Input\Input::INTERRUPTIVE_ITEMS = 'interruptive_items'

private

Definition at line 49 of file Input.php.

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

components/ILIAS/GlobalScreen/src/GUI/Input/Input.php

Public Member Functions

Data Fields

Private Attributes