ILIAS\News\Common\HttpService Class Reference

Collaboration diagram for ILIAS\News\Common\HttpService:

Public Member Functions
	__construct (private readonly IliasHttpServices $http, private readonly Refinery $refinery)
	getRequest ()
	getRefId ()
	resolveRowParameter (string $key)
	resolveRowParameters (string $key)
	get (string $key, Transformation $t)
	sendAsync (mixed $response)
	has (string $key)

Data Fields
const string	KEY_REF_ID = 'ref_id'
const string	ALL_OBJECTS = 'ALL_OBJECTS'

Detailed Description

Definition at line 30 of file HttpService.php.

Constructor & Destructor Documentation

__construct()

ILIAS\News\Common\HttpService::__construct	(	private readonly IliasHttpServices	$http,
		private readonly Refinery	$refinery
	)

Definition at line 36 of file HttpService.php.

      {
    }

Member Function Documentation

get()

ILIAS\News\Common\HttpService::get	(	string	$key,
		Transformation	$t
	)

Definition at line 75 of file HttpService.php.

                                                       : mixed
    {
        $wrapper = $this->http->wrapper();
 
        return match(true) {
            $wrapper->post()->has($key) => $wrapper->post()->retrieve($key, $t),
            $wrapper->query()->has($key) => $wrapper->query()->retrieve($key, $t),
            default => null,
        };
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

getRefId()

ILIAS\News\Common\HttpService::getRefId

(

)

Definition at line 47 of file HttpService.php.

                              : int
    {
        return $this->get(self::KEY_REF_ID, $this->refinery->kindlyTo()->int());
    }

References ILIAS\News\Common\HttpService\KEY_REF_ID, and ILIAS\Repository\refinery().

Here is the call graph for this function:

getRequest()

ILIAS\News\Common\HttpService::getRequest

(

)

Definition at line 42 of file HttpService.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

has()

ILIAS\News\Common\HttpService::has

(

string

$key

)

Definition at line 102 of file HttpService.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

resolveRowParameter()

ILIAS\News\Common\HttpService::resolveRowParameter

(

string

$key

)

Definition at line 52 of file HttpService.php.

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

References ILIAS\Repository\refinery().

Here is the call graph for this function:

resolveRowParameters()

ILIAS\News\Common\HttpService::resolveRowParameters

(

string

$key

)

Definition at line 66 of file HttpService.php.

                                                     : array|string
    {
        return $this->get($key, $this->refinery->custom()->transformation(
            static fn(array|string $value): array|string => $value === self::ALL_OBJECTS || $value[0] === self::ALL_OBJECTS
                ? self::ALL_OBJECTS
                : array_map('intval', $value)
        )) ?? [];
    }

References ILIAS\Repository\refinery().

Here is the call graph for this function:

sendAsync()

ILIAS\News\Common\HttpService::sendAsync

(

mixed

$response

)

Parameters

Stream | string | mixed

$response

Definition at line 89 of file HttpService.php.

                                              : void
    {
        $response = match(true) {
            is_string($response) => Streams::ofString($response),
            is_resource($response) => Streams::ofResource($response),
            default => $response,
        };
 
        $this->http->saveResponse($this->http->response()->withBody($response));
        $this->http->sendResponse();
        $this->http->close();
    }

References $response, ILIAS\FileDelivery\http(), ILIAS\Filesystem\Stream\Streams\ofResource(), and ILIAS\Filesystem\Stream\Streams\ofString().

Here is the call graph for this function:

Field Documentation

ALL_OBJECTS

const string ILIAS\News\Common\HttpService::ALL_OBJECTS = 'ALL_OBJECTS'

Definition at line 34 of file HttpService.php.

KEY_REF_ID

const string ILIAS\News\Common\HttpService::KEY_REF_ID = 'ref_id'

Definition at line 32 of file HttpService.php.

Referenced by ILIAS\News\Common\HttpService\getRefId().

---

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

• components/ILIAS/News/src/Common/HttpService.php