Collaboration diagram for ILIAS\User\Profile\GUIRequest:

Public Member Functions
	__construct (RequestServices $request, private Refinery $refinery)

	getUserId ()

	getBackUrl ()

	getBaseClass ()

	getPrompted ()

	getOsdId ()

	getFieldId ()

	getTerm ()

	getToken ()

	getUserFileCapture ()

	getParsedBody ()

Private Member Functions
	int (string $key)

	str (string $key)

	existsInPostOrQuery (string $key)

	getFromQueryOrPost (string $key, Transformation $transformation, string $source)

Private Attributes
WrapperFactory	$wrapper

array	$post

Detailed Description

Definition at line 28 of file GUIRequest.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\User\Profile\GUIRequest::__construct	(	RequestServices	$request,
		private Refinery	$refinery
	)

Definition at line 36 of file GUIRequest.php.

       {
         $this->wrapper = $request->wrapper();
         $this->post = $request->request()->getParsedBody();
     }

Member Function Documentation

◆ existsInPostOrQuery()

ILIAS\User\Profile\GUIRequest::existsInPostOrQuery ( string $key )

private

Todo:: 2023-06-05 sk: This is ugly and has to go, but right now, I have no idea, when I want to have information from $_POST or from $_GET.

Definition at line 134 of file GUIRequest.php.

Referenced by ILIAS\User\Profile\GUIRequest\int(), and ILIAS\User\Profile\GUIRequest\str().

                                                      : string
     {
         if ($this->wrapper->post()->has($key)) {
             return 'post';
         }
 
         if ($this->wrapper->query()->has($key)) {
             return 'query';
         }
 
         return '';
     }

Here is the caller graph for this function:

◆ getBackUrl()

ILIAS\User\Profile\GUIRequest::getBackUrl ( )

Definition at line 53 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\str().

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

Here is the call graph for this function:

◆ getBaseClass()

ILIAS\User\Profile\GUIRequest::getBaseClass ( )

Definition at line 58 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\str().

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

Here is the call graph for this function:

◆ getFieldId()

ILIAS\User\Profile\GUIRequest::getFieldId ( )

Definition at line 73 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\str().

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

Here is the call graph for this function:

◆ getFromQueryOrPost()

ILIAS\User\Profile\GUIRequest::getFromQueryOrPost	(	string	$key,
		Transformation	$transformation,
		string	$source
	)

private

Definition at line 147 of file GUIRequest.php.

Referenced by ILIAS\User\Profile\GUIRequest\int(), and ILIAS\User\Profile\GUIRequest\str().

                                                                                                     : string|int
     {
         if ($source === 'query') {
             return $this->wrapper->query()->retrieve($key, $transformation);
         }
 
         return $this->wrapper->post()->retrieve($key, $transformation);
     }

Here is the caller graph for this function:

◆ getOsdId()

ILIAS\User\Profile\GUIRequest::getOsdId ( )

Definition at line 68 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\int().

                               : int
     {
         return $this->int('osd_id');
     }

Here is the call graph for this function:

◆ getParsedBody()

ILIAS\User\Profile\GUIRequest::getParsedBody ( )

Todo:: 2023-06-05 sk: This is not what we want, but in order to avoid having a RequestInterface and a GUIRequest as class attributes

Definition at line 125 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\$post.

                                    : array
     {
         return $this->post;
     }

◆ getPrompted()

ILIAS\User\Profile\GUIRequest::getPrompted ( )

Definition at line 63 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\int().

                                  : int
     {
         return $this->int('prompted');
     }

Here is the call graph for this function:

◆ getTerm()

ILIAS\User\Profile\GUIRequest::getTerm ( )

Definition at line 78 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\str().

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

Here is the call graph for this function:

◆ getToken()

ILIAS\User\Profile\GUIRequest::getToken ( )

Definition at line 83 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\str().

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

Here is the call graph for this function:

◆ getUserFileCapture()

ILIAS\User\Profile\GUIRequest::getUserFileCapture ( )

Definition at line 88 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\str().

                                         : string
     {
         $capture = $this->str('userfile_capture');
 
         if ($capture !== '') {
             return $capture;
         }
 
         return $this->str('user_picture_carry');
     }

Here is the call graph for this function:

◆ getUserId()

ILIAS\User\Profile\GUIRequest::getUserId ( )

Definition at line 44 of file GUIRequest.php.

References $user_id, and ILIAS\User\Profile\GUIRequest\int().

                                : int
     {
         $user_id = $this->int('user_id');
         if ($user_id !== 0) {
             return $this->int('user_id');
         }
         return $this->int('user');
     }

Here is the call graph for this function:

◆ int()

ILIAS\User\Profile\GUIRequest::int ( string $key )

private

Definition at line 99 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\existsInPostOrQuery(), ILIAS\User\Profile\GUIRequest\getFromQueryOrPost(), and ILIAS\Repository\refinery().

Referenced by ILIAS\User\Profile\GUIRequest\getOsdId(), ILIAS\User\Profile\GUIRequest\getPrompted(), and ILIAS\User\Profile\GUIRequest\getUserId().

                                      : int
     {
         $source = $this->existsInPostOrQuery($key);
         if ($source === '') {
             return 0;
         }
 
         $transformation = $this->refinery->kindlyTo()->int();
         return $this->getFromQueryOrPost($key, $transformation, $source);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ str()

ILIAS\User\Profile\GUIRequest::str ( string $key )

private

Definition at line 110 of file GUIRequest.php.

References ILIAS\User\Profile\GUIRequest\existsInPostOrQuery(), ILIAS\User\Profile\GUIRequest\getFromQueryOrPost(), and ILIAS\Repository\refinery().

Referenced by ILIAS\User\Profile\GUIRequest\getBackUrl(), ILIAS\User\Profile\GUIRequest\getBaseClass(), ILIAS\User\Profile\GUIRequest\getFieldId(), ILIAS\User\Profile\GUIRequest\getTerm(), ILIAS\User\Profile\GUIRequest\getToken(), and ILIAS\User\Profile\GUIRequest\getUserFileCapture().

                                      : string
     {
         $source = $this->existsInPostOrQuery($key);
         if ($source === '') {
             return '';
         }
 
         $transformation = $this->refinery->kindlyTo()->string();
         return $this->getFromQueryOrPost($key, $transformation, $source);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $post

array ILIAS\User\Profile\GUIRequest::$post

private

Definition at line 34 of file GUIRequest.php.

Referenced by ILIAS\User\Profile\GUIRequest\getParsedBody().

◆ $wrapper

WrapperFactory ILIAS\User\Profile\GUIRequest::$wrapper

private

Definition at line 30 of file GUIRequest.php.

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

components/ILIAS/User/src/Profile/GUIRequest.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ existsInPostOrQuery()

◆ getBackUrl()

◆ getBaseClass()

◆ getFieldId()

◆ getFromQueryOrPost()

◆ getOsdId()

◆ getParsedBody()

◆ getPrompted()

◆ getTerm()

◆ getToken()

◆ getUserFileCapture()

◆ getUserId()

◆ int()

◆ str()

Field Documentation

◆ $post

◆ $wrapper