ILIAS\Test\RequestDataCollector Class Reference

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)
	getMultiSelectionIds (string $key)

Protected Attributes
array	$params

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

Detailed Description

Definition at line 31 of file RequestDataCollector.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 37 of file RequestDataCollector.php.

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

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

Here is the call graph for this function:

Member Function Documentation

getActiveId()

ILIAS\Test\RequestDataCollector::getActiveId

(

)

Definition at line 90 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[]

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

Definition at line 191 of file RequestDataCollector.php.

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

References ILIAS\UI\examples\Layout\Page\Standard\$refinery, and ILIAS\FileDelivery\http().

Here is the call graph for this function:

getNextCommand()

ILIAS\Test\RequestDataCollector::getNextCommand

(

)

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

(

)

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

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

(

)

Definition at line 75 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 80 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

(

)

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

(

)

Definition at line 44 of file RequestDataCollector.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

hasQuestionId()

ILIAS\Test\RequestDataCollector::hasQuestionId

(

)

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

(

)

Definition at line 54 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 115 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 156 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

)

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

Definition at line 133 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 177 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 172 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 164 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 100 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 138 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 35 of file RequestDataCollector.php.

---

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

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