Collaboration diagram for ILIAS\User\UserGUIRequest:

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

	getRefId ()

	getLetter ()

	getBaseClass ()

	getSearch ()

	getJumpToUser ()

	getFieldId ()

	getFetchAll ()

	getTerm ()

	getStartingPointId ()

	getRoleId ()

	getIds ()

	getChecked ()

	getFieldType ()

	getFields ()

	getSelectedAction ()

	getFrSearch ()

	getSelect ()

	getDefaultSessionReminder ()

	getFiles ()

	getExportType ()

	getMailSalutation (string $gender, string $lang)

	getMailSubject (string $lang)

	getMailBody (string $lang)

	getMailAttDelete (string $lang)

	getSelectAll ()

	getRoleIds ()

	getPostedRoleIds ()

	getFilteredRoles ()

	getSendMail ()

	getPassword ()

	getUDFs ()

	getPositions ()

	getParsedBody ()

	getRequest ()

	isPost ()

Protected Member Functions
	strArray (string $key)

	intArray (string $key)

Private Member Functions
	int (string $key)

	bool (string $key)

	str (string $key)

	existsInPostOrQuery (string $key)

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

Private Attributes
WrapperFactory	$wrapper

RequestInterface	$request

Detailed Description

Definition at line 29 of file UserGUIRequest.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 34 of file UserGUIRequest.php.

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

Member Function Documentation

◆ bool()

ILIAS\User\UserGUIRequest::bool ( string $key )

private

Definition at line 226 of file UserGUIRequest.php.

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

Referenced by ILIAS\User\UserGUIRequest\getFrSearch().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ existsInPostOrQuery()

ILIAS\User\UserGUIRequest::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 326 of file UserGUIRequest.php.

Referenced by ILIAS\User\UserGUIRequest\bool(), ILIAS\User\UserGUIRequest\int(), ILIAS\User\UserGUIRequest\intArray(), ILIAS\User\UserGUIRequest\str(), and ILIAS\User\UserGUIRequest\strArray().

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

◆ getBaseClass()

ILIAS\User\UserGUIRequest::getBaseClass ( )

Definition at line 52 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

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

Here is the call graph for this function:

◆ getChecked()

ILIAS\User\UserGUIRequest::getChecked ( )

Definition at line 110 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\intArray().

                                 : array
     {
         return $this->intArray('chb');
     }

Here is the call graph for this function:

◆ getDefaultSessionReminder()

ILIAS\User\UserGUIRequest::getDefaultSessionReminder ( )

Definition at line 140 of file UserGUIRequest.php.

References ilSessionReminder\LEAD_TIME_DISABLED, and ILIAS\User\UserGUIRequest\str().

                                                : ?string
     {
         return $this->str('default_session_reminder') ?: (string) \ilSessionReminder::LEAD_TIME_DISABLED;
     }

Here is the call graph for this function:

◆ getExportType()

ILIAS\User\UserGUIRequest::getExportType ( )

Definition at line 150 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

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

Here is the call graph for this function:

◆ getFetchAll()

ILIAS\User\UserGUIRequest::getFetchAll ( )

Definition at line 72 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

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

Here is the call graph for this function:

◆ getFieldId()

ILIAS\User\UserGUIRequest::getFieldId ( )

Definition at line 67 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

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

Here is the call graph for this function:

◆ getFields()

ILIAS\User\UserGUIRequest::getFields ( )

Definition at line 120 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\intArray().

                                : array
     {
         return $this->intArray('fields');
     }

Here is the call graph for this function:

◆ getFieldType()

ILIAS\User\UserGUIRequest::getFieldType ( )

Definition at line 115 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

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

Here is the call graph for this function:

◆ getFiles()

ILIAS\User\UserGUIRequest::getFiles ( )

Definition at line 145 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\strArray().

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

Here is the call graph for this function:

◆ getFilteredRoles()

ILIAS\User\UserGUIRequest::getFilteredRoles ( )

Definition at line 190 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

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

Here is the call graph for this function:

◆ getFromQueryOrPost()

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

private

Definition at line 339 of file UserGUIRequest.php.

Referenced by ILIAS\User\UserGUIRequest\bool(), ILIAS\User\UserGUIRequest\int(), ILIAS\User\UserGUIRequest\intArray(), ILIAS\User\UserGUIRequest\str(), and ILIAS\User\UserGUIRequest\strArray().

                                                                                                     : mixed
     {
         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:

◆ getFrSearch()

ILIAS\User\UserGUIRequest::getFrSearch ( )

Definition at line 130 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\bool().

                                  : bool
     {
         return $this->bool('frsrch');
     }

Here is the call graph for this function:

◆ getIds()

ILIAS\User\UserGUIRequest::getIds ( )

Definition at line 105 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\intArray().

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

Here is the call graph for this function:

◆ getJumpToUser()

ILIAS\User\UserGUIRequest::getJumpToUser ( )

Definition at line 62 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

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

Here is the call graph for this function:

◆ getLetter()

ILIAS\User\UserGUIRequest::getLetter ( )

Definition at line 47 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

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

Here is the call graph for this function:

◆ getMailAttDelete()

ILIAS\User\UserGUIRequest::getMailAttDelete ( string $lang )

Definition at line 170 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

                                                   : bool
     {
         return (bool) $this->int('att_' . $lang . '_delete');
     }

Here is the call graph for this function:

◆ getMailBody()

ILIAS\User\UserGUIRequest::getMailBody ( string $lang )

Definition at line 165 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

                                              : string
     {
         return $this->str('body_' . $lang);
     }

Here is the call graph for this function:

◆ getMailSalutation()

ILIAS\User\UserGUIRequest::getMailSalutation	(	string	$gender,
		string	$lang
	)

Definition at line 155 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

                                                                    : string
     {
         return $this->str('sal_' . $gender . '_' . $lang);
     }

Here is the call graph for this function:

◆ getMailSubject()

ILIAS\User\UserGUIRequest::getMailSubject ( string $lang )

Definition at line 160 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

                                                 : string
     {
         return $this->str('subject_' . $lang);
     }

Here is the call graph for this function:

◆ getParsedBody()

ILIAS\User\UserGUIRequest::getParsedBody ( )

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

Definition at line 307 of file UserGUIRequest.php.

                                    : array
     {
         return $this->request->getParsedBody();
     }

◆ getPassword()

ILIAS\User\UserGUIRequest::getPassword ( )

Definition at line 200 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

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

Here is the call graph for this function:

◆ getPositions()

ILIAS\User\UserGUIRequest::getPositions ( )

Definition at line 210 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\intArray().

                                   : array
     {
         return $this->intArray('position');
     }

Here is the call graph for this function:

◆ getPostedRoleIds()

ILIAS\User\UserGUIRequest::getPostedRoleIds ( )

Definition at line 185 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\intArray().

                                       : array
     {
         return $this->intArray('role_id_ctrl');
     }

Here is the call graph for this function:

◆ getRefId()

ILIAS\User\UserGUIRequest::getRefId ( )

Definition at line 42 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

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

Here is the call graph for this function:

◆ getRequest()

ILIAS\User\UserGUIRequest::getRequest ( )

Definition at line 312 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\$request.

                                 : RequestInterface
     {
         return $this->request;
     }

◆ getRoleId()

ILIAS\User\UserGUIRequest::getRoleId ( )

Definition at line 96 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

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

Here is the call graph for this function:

◆ getRoleIds()

ILIAS\User\UserGUIRequest::getRoleIds ( )

Definition at line 180 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\intArray().

                                 : array
     {
         return $this->intArray('role_id');
     }

Here is the call graph for this function:

◆ getSearch()

ILIAS\User\UserGUIRequest::getSearch ( )

Definition at line 57 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

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

Here is the call graph for this function:

◆ getSelect()

ILIAS\User\UserGUIRequest::getSelect ( )

Definition at line 135 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\strArray().

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

Here is the call graph for this function:

◆ getSelectAll()

ILIAS\User\UserGUIRequest::getSelectAll ( )

Definition at line 175 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\int().

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

Here is the call graph for this function:

◆ getSelectedAction()

ILIAS\User\UserGUIRequest::getSelectedAction ( )

Definition at line 125 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

Referenced by ilObjUserFolderGUI\__construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSendMail()

ILIAS\User\UserGUIRequest::getSendMail ( )

Definition at line 195 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

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

Here is the call graph for this function:

◆ getStartingPointId()

ILIAS\User\UserGUIRequest::getStartingPointId ( )

Definition at line 82 of file UserGUIRequest.php.

References $id, ILIAS\User\UserGUIRequest\int(), and null.

                                         : ?int
     {
         if (!$this->wrapper->query()->has('spid') &&
             !$this->wrapper->query()->has('start_point_id')) {
             return null;
         }
 
         $id = $this->int('spid');
         if ($id !== 0) {
             return $id;
         }
         return $this->int('start_point_id');
     }

Here is the call graph for this function:

◆ getTerm()

ILIAS\User\UserGUIRequest::getTerm ( )

Definition at line 77 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\str().

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

Here is the call graph for this function:

◆ getUDFs()

ILIAS\User\UserGUIRequest::getUDFs ( )

Definition at line 205 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\strArray().

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

Here is the call graph for this function:

◆ int()

ILIAS\User\UserGUIRequest::int ( string $key )

private

Definition at line 215 of file UserGUIRequest.php.

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

Referenced by ILIAS\User\UserGUIRequest\getFetchAll(), ILIAS\User\UserGUIRequest\getFieldId(), ILIAS\User\UserGUIRequest\getFieldType(), ILIAS\User\UserGUIRequest\getFilteredRoles(), ILIAS\User\UserGUIRequest\getJumpToUser(), ILIAS\User\UserGUIRequest\getMailAttDelete(), ILIAS\User\UserGUIRequest\getRefId(), ILIAS\User\UserGUIRequest\getRoleId(), ILIAS\User\UserGUIRequest\getSelectAll(), ILIAS\User\UserGUIRequest\getStartingPointId(), and ILIAS\User\UserGUIRequest\intArray().

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

◆ intArray()

ILIAS\User\UserGUIRequest::intArray ( string $key )

protected

Definition at line 276 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\existsInPostOrQuery(), ILIAS\User\UserGUIRequest\getFromQueryOrPost(), ILIAS\User\UserGUIRequest\int(), and ILIAS\Repository\refinery().

Referenced by ILIAS\User\UserGUIRequest\getChecked(), ILIAS\User\UserGUIRequest\getFields(), ILIAS\User\UserGUIRequest\getIds(), ILIAS\User\UserGUIRequest\getPositions(), ILIAS\User\UserGUIRequest\getPostedRoleIds(), and ILIAS\User\UserGUIRequest\getRoleIds().

                                             : array
     {
         $source = $this->existsInPostOrQuery($key);
         if ($source === '') {
             return [];
         }
 
         $transformation = $this->refinery->custom()->transformation(
             function ($arr) {
                 // 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 $this->getFromQueryOrPost($key, $transformation, $source);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPost()

ILIAS\User\UserGUIRequest::isPost ( )

Definition at line 317 of file UserGUIRequest.php.

                             : bool
     {
         return $this->request->getMethod() === 'POST';
     }

◆ str()

ILIAS\User\UserGUIRequest::str ( string $key )

private

Definition at line 237 of file UserGUIRequest.php.

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

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

◆ strArray()

ILIAS\User\UserGUIRequest::strArray ( string $key )

protected

Definition at line 248 of file UserGUIRequest.php.

References ILIAS\User\UserGUIRequest\existsInPostOrQuery(), ILIAS\User\UserGUIRequest\getFromQueryOrPost(), ILIAS\Repository\refinery(), and ilUtil\stripSlashes().

Referenced by ILIAS\User\UserGUIRequest\getFiles(), ILIAS\User\UserGUIRequest\getSelect(), and ILIAS\User\UserGUIRequest\getUDFs().

                                             : array
     {
         $source = $this->existsInPostOrQuery($key);
         if ($source === '') {
             return [];
         }
 
         $transformation = $this->refinery->custom()->transformation(
             function ($arr) {
                 return array_column(
                     array_map(
                         static function ($k, $v): array {
                             if (is_array($v)) {
                                 $v = '';
                             }
                             return [$k, \ilUtil::stripSlashes((string) $v)];
                         },
                         array_keys($arr),
                         $arr
                     ),
                     1,
                     0
                 );
             }
         );
         return $this->getFromQueryOrPost($key, $transformation, $source);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $request

RequestInterface ILIAS\User\UserGUIRequest::$request

private

Definition at line 32 of file UserGUIRequest.php.

Referenced by ILIAS\User\UserGUIRequest\getRequest().

◆ $wrapper

WrapperFactory ILIAS\User\UserGUIRequest::$wrapper

private

Definition at line 31 of file UserGUIRequest.php.

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

components/ILIAS/User/src/UserGUIRequest.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ bool()

◆ existsInPostOrQuery()

◆ getBaseClass()

◆ getChecked()

◆ getDefaultSessionReminder()

◆ getExportType()

◆ getFetchAll()

◆ getFieldId()

◆ getFields()

◆ getFieldType()

◆ getFiles()

◆ getFilteredRoles()

◆ getFromQueryOrPost()

◆ getFrSearch()

◆ getIds()

◆ getJumpToUser()

◆ getLetter()

◆ getMailAttDelete()

◆ getMailBody()

◆ getMailSalutation()

◆ getMailSubject()

◆ getParsedBody()

◆ getPassword()

◆ getPositions()

◆ getPostedRoleIds()

◆ getRefId()

◆ getRequest()

◆ getRoleId()

◆ getRoleIds()

◆ getSearch()

◆ getSelect()

◆ getSelectAll()

◆ getSelectedAction()

◆ getSendMail()

◆ getStartingPointId()

◆ getTerm()

◆ getUDFs()

◆ int()

◆ intArray()

◆ isPost()

◆ str()

◆ strArray()

Field Documentation

◆ $request

◆ $wrapper