ILIAS\TestQuestionPool\RequestDataCollector Class Reference

Inheritance diagram for ILIAS\TestQuestionPool\RequestDataCollector:

Collaboration diagram for ILIAS\TestQuestionPool\RequestDataCollector:

Public Member Functions
	__construct (Services $http, Factory $refinery, protected readonly FileUpload $upload)
	getRequest ()
	getProcessedUploads ()
	upload ()
	isset (string $key)
	hasRefId ()
	getRefId ()
	hasQuestionId ()
	getQuestionId ()
	getIds ()
	raw (string $key)
	float (string $key)
	string (string $key)
	bool (string $key)
	getParsedBody ()
	getUnitIds ()
	getUnitCategoryIds ()
	getMatchingPairs ()
	getNumericGapValue (int $gap_index)
	getPostKeys ()
	getCmdIndex (string $key)
	strArray (string $key, int $depth=1)
	floatArray (string $key)
	intArray (string $key)
	rawArray (string $key)
	getRowIdParameter (string $key)
	getMultiSelectionIds (string $key)
	getNumericQuestionSolutionSubmit ()
	getRequest ()
	isset (string $key)
	hasRefId ()
	getRefId ()
	hasQuestionId ()
	getQuestionId ()
	getIds ()
	raw (string $key)
	getParsedBody ()
	getPostKeys ()
	getMultiSelectionIds (string $key)
	getRowIdParameter (string $key)

Private Member Functions
	retrieveArray (string $key, int $depth, Transformation $transformation)

Detailed Description

Definition at line 31 of file RequestDataCollector.php.

Constructor & Destructor Documentation

__construct()

ILIAS\TestQuestionPool\RequestDataCollector::__construct	(	Services	$http,
		Factory	$refinery,
		protected readonly FileUpload	$upload
	)

Definition at line 35 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

bool()

ILIAS\TestQuestionPool\RequestDataCollector::bool

(

string

$key

)

Definition at line 153 of file RequestDataCollector.php.

                                     : ?bool
    {
        return $this->get($key, $this->refinery->kindlyTo()->bool());
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

float()

ILIAS\TestQuestionPool\RequestDataCollector::float

(

string

$key

)

Definition at line 139 of file RequestDataCollector.php.

                                      : float
    {
        try {
            return $this->get($key, $this->refinery->kindlyTo()->float()) ?? 0.0;
        } catch (ConstraintViolationException $e) {
            return 0.0;
        }
    }

References Vendor\Package\$e, and ILIAS\Repository\refinery().

Here is the call graph for this function:

floatArray()

ILIAS\TestQuestionPool\RequestDataCollector::floatArray

(

string

$key

)

Returns

array<float>

Definition at line 237 of file RequestDataCollector.php.

                                           : array
    {
        return $this->retrieveArray($key, 1, $this->refinery->kindlyTo()->float());
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

getCmdIndex()

ILIAS\TestQuestionPool\RequestDataCollector::getCmdIndex

(

string

$key

)

Definition at line 217 of file RequestDataCollector.php.

                                            : int|string|null
    {
        $cmd = $this->rawArray('cmd');
        if (!isset($cmd[$key]) || !is_array($cmd[$key])) {
            return null;
        }
        return key($cmd[$key]);
    }

getIds()

ILIAS\TestQuestionPool\RequestDataCollector::getIds

(

)

Returns

array<string>

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 126 of file RequestDataCollector.php.

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

References ILIAS\TestQuestionPool\RequestDataCollector\strArray().

Here is the call graph for this function:

getMatchingPairs()

ILIAS\TestQuestionPool\RequestDataCollector::getMatchingPairs

(

)

Definition at line 179 of file RequestDataCollector.php.

                                      : array
    {
        if (!$this->http->wrapper()->post()->has('matching')) {
            return [];
        }
 
        return $this->http->wrapper()->post()->retrieve(
            'matching',
            $this->refinery->byTrying([
                $this->refinery->container()->mapValues(
                    $this->refinery->custom()->transformation(
                        fn(string $v): array => $this->refinery->container()->mapValues(
                            $this->refinery->kindlyTo()->int()
                        )->transform(json_decode($v))
                    )
                ),
                $this->refinery->always([])
            ])
        );
    }

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

Here is the call graph for this function:

getMultiSelectionIds()

ILIAS\TestQuestionPool\RequestDataCollector::getMultiSelectionIds

(

string

$key

)

Returns

array<int>|string

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 270 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:

getNumericGapValue()

ILIAS\TestQuestionPool\RequestDataCollector::getNumericGapValue

(

int

$gap_index

)

Definition at line 200 of file RequestDataCollector.php.

     : ?float {
        return $this->http->wrapper()->post()->retrieve(
            "gap_{$gap_index}_numeric",
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->float(),
                $this->refinery->always(null)
            ])
        );
    }

getNumericQuestionSolutionSubmit()

ILIAS\TestQuestionPool\RequestDataCollector::getNumericQuestionSolutionSubmit

(

)

Definition at line 288 of file RequestDataCollector.php.

                                                      : ?float
    {
        return $this->http->wrapper()->post()->retrieve(
            'numeric_result',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->float(),
                $this->refinery->always(null)
            ])
        );
    }

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

Here is the call graph for this function:

getParsedBody()

ILIAS\TestQuestionPool\RequestDataCollector::getParsedBody

(

)

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 158 of file RequestDataCollector.php.

                                   : object|array|null
    {
        return $this->http->request()->getParsedBody();
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

getPostKeys()

ILIAS\TestQuestionPool\RequestDataCollector::getPostKeys

(

)

Returns

array<string|int>

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 212 of file RequestDataCollector.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

getProcessedUploads()

ILIAS\TestQuestionPool\RequestDataCollector::getProcessedUploads

(

)

Returns

array<UploadResult>

Definition at line 51 of file RequestDataCollector.php.

                                         : array
    {
        $uploads = [];
 
        if ($this->upload->hasUploads()) {
            if (!$this->upload->hasBeenProcessed()) {
                $this->upload->process();
            }
            $uploads = $this->upload->getResults();
        }
 
        return $uploads;
    }

References ILIAS\TestQuestionPool\RequestDataCollector\upload().

Here is the call graph for this function:

getQuestionId()

ILIAS\TestQuestionPool\RequestDataCollector::getQuestionId

(

)

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 118 of file RequestDataCollector.php.

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

References ILIAS\Repository\int().

Here is the call graph for this function:

getRefId()

ILIAS\TestQuestionPool\RequestDataCollector::getRefId

(

)

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 108 of file RequestDataCollector.php.

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

References ILIAS\Repository\int().

Here is the call graph for this function:

getRequest()

ILIAS\TestQuestionPool\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\TestQuestionPool\RequestDataCollector::getRowIdParameter

(

string

$key

)

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 258 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:

getUnitCategoryIds()

ILIAS\TestQuestionPool\RequestDataCollector::getUnitCategoryIds

(

)

Returns

array<int>

Definition at line 174 of file RequestDataCollector.php.

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

References ILIAS\TestQuestionPool\RequestDataCollector\intArray().

Here is the call graph for this function:

getUnitIds()

ILIAS\TestQuestionPool\RequestDataCollector::getUnitIds

(

)

Returns

array<int>

Definition at line 166 of file RequestDataCollector.php.

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

References ILIAS\TestQuestionPool\RequestDataCollector\intArray().

Here is the call graph for this function:

hasQuestionId()

ILIAS\TestQuestionPool\RequestDataCollector::hasQuestionId

(

)

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 113 of file RequestDataCollector.php.

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

References ILIAS\TestQuestionPool\RequestDataCollector\raw().

Here is the call graph for this function:

hasRefId()

ILIAS\TestQuestionPool\RequestDataCollector::hasRefId

(

)

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 103 of file RequestDataCollector.php.

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

References ILIAS\TestQuestionPool\RequestDataCollector\raw().

Here is the call graph for this function:

intArray()

ILIAS\TestQuestionPool\RequestDataCollector::intArray

(

string

$key

)

Returns

array<int>

Definition at line 245 of file RequestDataCollector.php.

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

References ILIAS\Repository\refinery().

Referenced by ILIAS\TestQuestionPool\RequestDataCollector\getUnitCategoryIds(), and ILIAS\TestQuestionPool\RequestDataCollector\getUnitIds().

Here is the call graph for this function:

Here is the caller graph for this function:

isset()

ILIAS\TestQuestionPool\RequestDataCollector::isset

(

string

$key

)

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 98 of file RequestDataCollector.php.

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

References ILIAS\TestQuestionPool\RequestDataCollector\raw().

Here is the call graph for this function:

raw()

ILIAS\TestQuestionPool\RequestDataCollector::raw

(

string

$key

)

Returns

mixed|null

Implements ILIAS\TestQuestionPool\RequestDataCollectorInterface.

Definition at line 134 of file RequestDataCollector.php.

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

References ILIAS\Repository\refinery().

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

Here is the call graph for this function:

Here is the caller graph for this function:

rawArray()

ILIAS\TestQuestionPool\RequestDataCollector::rawArray

(

string

$key

)

Returns

array<mixed|array>

Definition at line 253 of file RequestDataCollector.php.

                                         : array
    {
        return $this->retrieveArray($key, 1, $this->refinery->identity());
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

retrieveArray()

ILIAS\TestQuestionPool\RequestDataCollector::retrieveArray ( string  $key, int  $depth, Transformation  $transformation  )

private

Definition at line 299 of file RequestDataCollector.php.

                                                                                           : array
    {
        $chain = $this->refinery->kindlyTo()->dictOf($transformation);
        for ($i = 1; $i < $depth; $i++) {
            $chain = $this->refinery->kindlyTo()->dictOf($chain);
        }
 
        return $this->get(
            $key,
            $this->refinery->byTrying([
                $chain,
                $this->refinery->always([])
            ])
        ) ?? [];
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

strArray()

ILIAS\TestQuestionPool\RequestDataCollector::strArray	(	string	$key,
		int	$depth = 1
	)

Returns

array<string|array>

Definition at line 229 of file RequestDataCollector.php.

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

References ILIAS\Repository\refinery().

Referenced by ILIAS\TestQuestionPool\RequestDataCollector\getIds().

Here is the call graph for this function:

Here is the caller graph for this function:

string()

ILIAS\TestQuestionPool\RequestDataCollector::string

(

string

$key

)

Definition at line 148 of file RequestDataCollector.php.

                                       : string
    {
        return $this->get($key, $this->refinery->kindlyTo()->string()) ?? '';
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

upload()

ILIAS\TestQuestionPool\RequestDataCollector::upload

(

)

Definition at line 93 of file RequestDataCollector.php.

                            : FileUpload
    {
        return $this->upload;
    }

Referenced by ILIAS\TestQuestionPool\RequestDataCollector\getProcessedUploads().

Here is the caller graph for this function:

---

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

• components/ILIAS/TestQuestionPool/src/RequestDataCollector.php