Inheritance diagram for ILIAS\Test\RequestDataCollector:

Collaboration diagram for ILIAS\Test\RequestDataCollector:

Public Member Functions
	__construct (HTTPServices $http, Refinery $refinery)

	getRequest ()

	isset (string $key)

	hasRefId ()

	getRefId ()

	getIds ()

	hasQuestionId ()

	getQuestionId ()

	getQuestionIds ()

	getNextCommand ()

	getActiveId ()

	getPassId ()

	retrieveBoolFromPost (string $key)

	isInstanceResponseRequested ()

	raw (string $key)

	strVal (string $key)

	getParsedBody ()

	getPostKeys ()

	isPostRequest ()

	retrieveArrayOfStringsFromPost (string $key)

	retrieveArrayOfIntsFromPost (string $key)

	getRowIdParameter (string $key)

	getMultiSelectionIds (string $key)

	getRequest ()

	isset (string $key)

	hasRefId ()

	getRefId ()

	hasQuestionId ()

	getQuestionId ()

	getIds ()

	raw (string $key)

	getParsedBody ()

	getPostKeys ()

	getMultiSelectionIds (string $key)

	getRowIdParameter (string $key)

Protected Attributes
array	$params

Private Member Functions
	retrieveArrayFromPost (string $key, Transformation $transformation)

Detailed Description

Definition at line 30 of file RequestDataCollector.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\RequestDataCollector::__construct	(	HTTPServices	$http,
		Refinery	$refinery
	)

Definition at line 36 of file RequestDataCollector.php.

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

References ILIAS\UI\examples\Layout\Page\Mail\$refinery, and ILIAS\Repository\initRequest().

Here is the call graph for this function:

Member Function Documentation

◆ getActiveId()

ILIAS\Test\RequestDataCollector::getActiveId ( )

Definition at line 89 of file RequestDataCollector.php.

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

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getIds()

ILIAS\Test\RequestDataCollector::getIds ( )

Returns: string[]

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 64 of file RequestDataCollector.php.

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

References ILIAS\Repository\strArray().

Here is the call graph for this function:

◆ getMultiSelectionIds()

ILIAS\Test\RequestDataCollector::getMultiSelectionIds ( string $key )

Returns: array|string<int>

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 199 of file RequestDataCollector.php.

                                                     : array|string
    {
        $query = $this->http->wrapper()->query();
 
        if (!$query->has($key)) {
            return [];
        }
 
        return $query->retrieve(
            $key,
            $this->refinery->custom()->transformation(
                static fn(array|string $value): array|string => $value === 'ALL_OBJECTS' || $value[0] === 'ALL_OBJECTS'
                    ? 'ALL_OBJECTS'
                    : array_map('intval', $value)
            )
        );
    }

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

Here is the call graph for this function:

◆ getNextCommand()

ILIAS\Test\RequestDataCollector::getNextCommand ( )

Definition at line 84 of file RequestDataCollector.php.

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

References ILIAS\Repository\str().

Here is the call graph for this function:

◆ getParsedBody()

ILIAS\Test\RequestDataCollector::getParsedBody ( )

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 142 of file RequestDataCollector.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ getPassId()

ILIAS\Test\RequestDataCollector::getPassId ( )

Definition at line 94 of file RequestDataCollector.php.

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

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getPostKeys()

ILIAS\Test\RequestDataCollector::getPostKeys ( )

Deprecated:

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 150 of file RequestDataCollector.php.

                                 : array
    {
        return $this->http->wrapper()->post()->keys();
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ getQuestionId()

ILIAS\Test\RequestDataCollector::getQuestionId ( )

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 74 of file RequestDataCollector.php.

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

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getQuestionIds()

ILIAS\Test\RequestDataCollector::getQuestionIds ( )

Definition at line 79 of file RequestDataCollector.php.

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

References ILIAS\Repository\intArray().

Here is the call graph for this function:

◆ getRefId()

ILIAS\Test\RequestDataCollector::getRefId ( )

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 58 of file RequestDataCollector.php.

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

References ILIAS\Repository\int().

Here is the call graph for this function:

◆ getRequest()

ILIAS\Test\RequestDataCollector::getRequest ( )

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 43 of file RequestDataCollector.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ getRowIdParameter()

ILIAS\Test\RequestDataCollector::getRowIdParameter ( string $key )

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 187 of file RequestDataCollector.php.

                                                  : string|int
    {
        return $this->get($key, $this->refinery->byTrying([
            $this->refinery->kindlyTo()->int(),
            $this->refinery->kindlyTo()->string(),
            $this->refinery->custom()->transformation(fn(array $v): string|int => $v[0])
        ]));
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ hasQuestionId()

ILIAS\Test\RequestDataCollector::hasQuestionId ( )

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 69 of file RequestDataCollector.php.

                                   : bool
    {
        return $this->raw('q_id') !== null;
    }

References ILIAS\Test\RequestDataCollector\raw().

Here is the call graph for this function:

◆ hasRefId()

ILIAS\Test\RequestDataCollector::hasRefId ( )

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 53 of file RequestDataCollector.php.

                              : bool
    {
        return $this->raw('ref_id') !== null;
    }

References ILIAS\Test\RequestDataCollector\raw().

Here is the call graph for this function:

◆ isInstanceResponseRequested()

ILIAS\Test\RequestDataCollector::isInstanceResponseRequested ( )

Definition at line 114 of file RequestDataCollector.php.

                                                 : bool
    {
        if (!$this->http->wrapper()->query()->has('instresp')) {
            return false;
        }
 
        return $this->http->wrapper()->query()->retrieve(
            'instresp',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->bool(),
                $this->refinery->always(false)
            ])
        );
    }

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

Here is the call graph for this function:

◆ isPostRequest()

ILIAS\Test\RequestDataCollector::isPostRequest ( )

Definition at line 155 of file RequestDataCollector.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

◆ isset()

ILIAS\Test\RequestDataCollector::isset ( string $key )

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 48 of file RequestDataCollector.php.

                                      : bool
    {
        return $this->raw($key) !== null;
    }

References ILIAS\Test\RequestDataCollector\raw().

Here is the call graph for this function:

◆ raw()

ILIAS\Test\RequestDataCollector::raw ( string $key )

Returns: mixed|null

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 132 of file RequestDataCollector.php.

                                    : mixed
    {
        return $this->get($key, $this->refinery->identity());
    }

References ILIAS\Repository\refinery().

Referenced by ILIAS\Test\RequestDataCollector\hasQuestionId(), ILIAS\Test\RequestDataCollector\hasRefId(), and ILIAS\Test\RequestDataCollector\isset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveArrayFromPost()

ILIAS\Test\RequestDataCollector::retrieveArrayFromPost	(	string	$key,
		Transformation	$transformation
	)

private

Definition at line 176 of file RequestDataCollector.php.

                                                                                       : array
    {
        return $this->http->wrapper()->post()->retrieve(
            $key,
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($transformation),
                $this->refinery->always([])
            ])
        );
    }

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

Referenced by ILIAS\Test\RequestDataCollector\retrieveArrayOfIntsFromPost(), and ILIAS\Test\RequestDataCollector\retrieveArrayOfStringsFromPost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveArrayOfIntsFromPost()

ILIAS\Test\RequestDataCollector::retrieveArrayOfIntsFromPost ( string $key )

Returns: array<int>

Definition at line 171 of file RequestDataCollector.php.

                                                            : array
    {
        return $this->retrieveArrayFromPost($key, $this->refinery->kindlyTo()->int());
    }

References ILIAS\Repository\refinery(), and ILIAS\Test\RequestDataCollector\retrieveArrayFromPost().

Here is the call graph for this function:

◆ retrieveArrayOfStringsFromPost()

ILIAS\Test\RequestDataCollector::retrieveArrayOfStringsFromPost ( string $key )

Returns: array<string>

Definition at line 163 of file RequestDataCollector.php.

                                                               : array
    {
        return $this->retrieveArrayFromPost($key, $this->refinery->kindlyTo()->string());
    }

References ILIAS\Repository\refinery(), and ILIAS\Test\RequestDataCollector\retrieveArrayFromPost().

Here is the call graph for this function:

◆ retrieveBoolFromPost()

ILIAS\Test\RequestDataCollector::retrieveBoolFromPost ( string $key )

Definition at line 99 of file RequestDataCollector.php.

                                                     : ?bool
    {
        if (!$this->http->wrapper()->post()->has($key)) {
            return null;
        }
 
        return $this->http->wrapper()->post()->retrieve(
            $key,
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->bool(),
                $this->refinery->always(null)
            ])
        );
    }

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

Here is the call graph for this function:

◆ strVal()

ILIAS\Test\RequestDataCollector::strVal ( string $key )

Definition at line 137 of file RequestDataCollector.php.

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

References ILIAS\Repository\str().

Here is the call graph for this function:

Field Documentation

◆ $params

array ILIAS\Test\RequestDataCollector::$params

protected

Definition at line 34 of file RequestDataCollector.php.

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

components/ILIAS/Test/src/RequestDataCollector.php

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActiveId()

◆ getIds()

◆ getMultiSelectionIds()

◆ getNextCommand()

◆ getParsedBody()

◆ getPassId()

◆ getPostKeys()

◆ getQuestionId()

◆ getQuestionIds()

◆ getRefId()

◆ getRequest()

◆ getRowIdParameter()

◆ hasQuestionId()

◆ hasRefId()

◆ isInstanceResponseRequested()

◆ isPostRequest()

◆ isset()

◆ raw()

◆ retrieveArrayFromPost()

◆ retrieveArrayOfIntsFromPost()

◆ retrieveArrayOfStringsFromPost()

◆ retrieveBoolFromPost()

◆ strVal()

Field Documentation

◆ $params