ILIAS\User\Profile\GUIRequest Class Reference

Collaboration diagram for ILIAS\User\Profile\GUIRequest:

Public Member Functions
	__construct (RequestServices $request, private Refinery $refinery)
	getUserId ()
	getBackUrl ()
	getBaseClass ()
	getPrompted ()
	getOsdId ()
	getFieldId ()
	getTerm ()
	getToken ()
	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 123 of file GUIRequest.php.

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

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

Here is the caller graph for this function:

getBackUrl()

ILIAS\User\Profile\GUIRequest::getBackUrl

(

)

Definition at line 53 of file GUIRequest.php.

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

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

Here is the call graph for this function:

getBaseClass()

ILIAS\User\Profile\GUIRequest::getBaseClass

(

)

Definition at line 58 of file GUIRequest.php.

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

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

Here is the call graph for this function:

getFieldId()

ILIAS\User\Profile\GUIRequest::getFieldId

(

)

Definition at line 73 of file GUIRequest.php.

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

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

Here is the call graph for this function:

getFromQueryOrPost()

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

private

Definition at line 136 of file GUIRequest.php.

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

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

Here is the caller graph for this function:

getOsdId()

ILIAS\User\Profile\GUIRequest::getOsdId

(

)

Definition at line 68 of file GUIRequest.php.

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

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

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 114 of file GUIRequest.php.

                                   : array
    {
        return $this->post;
    }

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

getPrompted()

ILIAS\User\Profile\GUIRequest::getPrompted

(

)

Definition at line 63 of file GUIRequest.php.

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

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

Here is the call graph for this function:

getTerm()

ILIAS\User\Profile\GUIRequest::getTerm

(

)

Definition at line 78 of file GUIRequest.php.

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

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

Here is the call graph for this function:

getToken()

ILIAS\User\Profile\GUIRequest::getToken

(

)

Definition at line 83 of file GUIRequest.php.

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

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

Here is the call graph for this function:

getUserId()

ILIAS\User\Profile\GUIRequest::getUserId

(

)

Definition at line 44 of file GUIRequest.php.

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

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

Here is the call graph for this function:

int()

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

private

Definition at line 88 of file GUIRequest.php.

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

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

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 99 of file GUIRequest.php.

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

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(), and ILIAS\User\Profile\GUIRequest\getToken().

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