ilObjectRequestRetriever Class Reference

Base class for all sub item list gui's. More...

Collaboration diagram for ilObjectRequestRetriever:

Public Member Functions
	__construct (WrapperFactory $wrapper, Factory $refinery)
	has (string $key)
	getMaybeInt (string $key, ?int $fallback=null)
	getMaybeString (string $key, ?string $fallback=null)
	getArrayOfInt (string $key)
	getBool (string $key)
	getSelectedIdsFromObjectList ()

Protected Attributes
WrapperFactory	$wrapper
Factory	$refinery

Private Member Functions
	getFromRequest (string $key, Transformation $t)

Detailed Description

Base class for all sub item list gui's.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 30 of file class.ilObjectRequestRetriever.php.

Constructor & Destructor Documentation

__construct()

ilObjectRequestRetriever::__construct	(	WrapperFactory	$wrapper,
		Factory	$refinery
	)

Definition at line 35 of file class.ilObjectRequestRetriever.php.

References $refinery, $wrapper, and ILIAS\Repository\refinery().

    {
        $this->wrapper = $wrapper;
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

getArrayOfInt()

ilObjectRequestRetriever::getArrayOfInt

(

string

$key

)

Definition at line 71 of file class.ilObjectRequestRetriever.php.

References getFromRequest(), and ILIAS\Repository\refinery().

                                              : array
    {
        return $this->getFromRequest(
            $key,
            $this->refinery->kindlyTo()->dictOf(
                $this->refinery->kindlyTo()->int()
            )
        ) ?? [];
    }

Here is the call graph for this function:

getBool()

ilObjectRequestRetriever::getBool

(

string

$key

)

Definition at line 81 of file class.ilObjectRequestRetriever.php.

References getFromRequest(), and ILIAS\Repository\refinery().

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

Here is the call graph for this function:

getFromRequest()

ilObjectRequestRetriever::getFromRequest ( string  $key, Transformation  $t  )

private

Returns

mixed

Definition at line 44 of file class.ilObjectRequestRetriever.php.

Referenced by getArrayOfInt(), getBool(), getMaybeInt(), and getMaybeString().

    {
        if ($this->wrapper->query()->has($key)) {
            return $this->wrapper->query()->retrieve($key, $t);
        }
        if ($this->wrapper->post()->has($key)) {
            return $this->wrapper->post()->retrieve($key, $t);
        }
        return null;
    }

Here is the caller graph for this function:

getMaybeInt()

ilObjectRequestRetriever::getMaybeInt	(	string	$key,
		?int	$fallback = null
	)

Definition at line 61 of file class.ilObjectRequestRetriever.php.

References getFromRequest(), and ILIAS\Repository\refinery().

                                                                   : ?int
    {
        return $this->getFromRequest($key, $this->refinery->kindlyTo()->int()) ?? $fallback;
    }

Here is the call graph for this function:

getMaybeString()

ilObjectRequestRetriever::getMaybeString	(	string	$key,
		?string	$fallback = null
	)

Definition at line 66 of file class.ilObjectRequestRetriever.php.

References getFromRequest(), and ILIAS\Repository\refinery().

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

Here is the call graph for this function:

getSelectedIdsFromObjectList()

ilObjectRequestRetriever::getSelectedIdsFromObjectList

(

)

Definition at line 86 of file class.ilObjectRequestRetriever.php.

References ILIAS\Repository\refinery().

                                                  : array
    {
        if ($this->wrapper->query()->has('tl_id')) {
            return [$this->wrapper->query()->retrieve(
                'tl_id',
                $this->refinery->kindlyTo()->int()
            )];
        }
        if ($this->wrapper->post()->has('id')) {
            return $this->wrapper->post()->retrieve(
                'id',
                $this->refinery->container()->mapValues(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        return [];
    }

Here is the call graph for this function:

has()

ilObjectRequestRetriever::has

(

string

$key

)

Definition at line 55 of file class.ilObjectRequestRetriever.php.

                                    : bool
    {
        return $this->wrapper->query()->has($key)
            || $this->wrapper->post()->has($key);
    }

Field Documentation

$refinery

Factory ilObjectRequestRetriever::$refinery

protected

Definition at line 33 of file class.ilObjectRequestRetriever.php.

Referenced by __construct().

$wrapper

WrapperFactory ilObjectRequestRetriever::$wrapper

protected

Definition at line 32 of file class.ilObjectRequestRetriever.php.

Referenced by __construct().

---

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

• components/ILIAS/ILIASObject/classes/class.ilObjectRequestRetriever.php