Provides an interface to the ILIAS HTTP services. More...

Inheritance diagram for ILIAS\DI\HTTPServices:

Collaboration diagram for ILIAS\DI\HTTPServices:

Public Member Functions
	__construct (ResponseSenderStrategy $senderStrategy, CookieJarFactory $cookieJarFactory, RequestFactory $requestFactory, ResponseFactory $responseFactory)
	HTTPServices constructor. More...

	cookieJar ()
	@inheritDoc More...

	request ()
	@inheritDoc More...

	response ()
	@inheritDoc More...

	saveRequest (ServerRequestInterface $request)
	@inheritDoc More...

	saveResponse (ResponseInterface $response)
	@inheritDoc More...

	sendResponse ()
	@inheritDoc More...

	close ()

	request ()
	Returns the current psr-7 server request. More...

	response ()
	Returns the current psr-7 response. More...

	cookieJar ()
	Returns a cookie jar which has all cookies known by the ILIAS response. More...

	saveRequest (ServerRequestInterface $request)
	Saves the given request for further use. More...

	saveResponse (ResponseInterface $response)
	Saves the given response for further use. More...

	sendResponse ()
	Render the current response hold by ILIAS. More...

	close ()

Private Attributes
	$sender

	$cookieJarFactory

	$requestFactory

	$responseFactory

	$request

	$response

Detailed Description

Provides an interface to the ILIAS HTTP services.

Author: Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 20 of file HTTPServices.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\DI\HTTPServices::__construct	(	ResponseSenderStrategy	$senderStrategy,
		CookieJarFactory	$cookieJarFactory,
		RequestFactory	$requestFactory,
		ResponseFactory	$responseFactory
	)

HTTPServices constructor.

Parameters

ResponseSenderStrategy	$senderStrategy	A response sender strategy.
CookieJarFactory	$cookieJarFactory	Cookie Jar implementation.
RequestFactory	$requestFactory
ResponseFactory	$responseFactory

Definition at line 57 of file HTTPServices.php.

    {
        $this->sender = $senderStrategy;
        $this->cookieJarFactory = $cookieJarFactory;
 
        $this->requestFactory = $requestFactory;
        $this->responseFactory = $responseFactory;
    }

References ILIAS\DI\HTTPServices\$cookieJarFactory, ILIAS\DI\HTTPServices\$requestFactory, and ILIAS\DI\HTTPServices\$responseFactory.

Member Function Documentation

◆ close()

ILIAS\DI\HTTPServices::close ( )

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 129 of file HTTPServices.php.

References exit.

◆ cookieJar()

ILIAS\DI\HTTPServices::cookieJar ( )

@inheritDoc

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 70 of file HTTPServices.php.

                                : CookieJar
    {
        return $this->cookieJarFactory->fromResponse($this->response());
    }

References ILIAS\DI\HTTPServices\response().

Here is the call graph for this function:

◆ request()

ILIAS\DI\HTTPServices::request ( )

@inheritDoc

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 79 of file HTTPServices.php.

                              : \Psr\Http\Message\RequestInterface
    {
        if ($this->request === null) {
            $this->request = $this->requestFactory->create();
        }
 
        return $this->request;
    }

References ILIAS\DI\HTTPServices\$request, and ILIAS\DI\HTTPServices\request().

Referenced by ILIAS\DI\HTTPServices\request(), and ILIAS\DI\HTTPServices\saveRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ response()

ILIAS\DI\HTTPServices::response ( )

@inheritDoc

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 92 of file HTTPServices.php.

                               : ResponseInterface
    {
        if ($this->response === null) {
            $this->response = $this->responseFactory->create();
        }
 
        return $this->response;
    }

References ILIAS\DI\HTTPServices\$response, and ILIAS\DI\HTTPServices\response().

Referenced by ILIAS\DI\HTTPServices\cookieJar(), ILIAS\DI\HTTPServices\response(), ILIAS\DI\HTTPServices\saveResponse(), and ILIAS\DI\HTTPServices\sendResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveRequest()

ILIAS\DI\HTTPServices::saveRequest ( ServerRequestInterface $request )

@inheritDoc

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 105 of file HTTPServices.php.

                                                                 : void
    {
        $this->request = $request;
    }

References ILIAS\DI\HTTPServices\$request, and ILIAS\DI\HTTPServices\request().

Here is the call graph for this function:

◆ saveResponse()

ILIAS\DI\HTTPServices::saveResponse ( ResponseInterface $response )

@inheritDoc

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 114 of file HTTPServices.php.

                                                              : void
    {
        $this->response = $response;
    }

References ILIAS\DI\HTTPServices\$response, and ILIAS\DI\HTTPServices\response().

Here is the call graph for this function:

◆ sendResponse()

ILIAS\DI\HTTPServices::sendResponse ( )

@inheritDoc

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 123 of file HTTPServices.php.

                                   : void
    {
        $this->sender->sendResponse($this->response());
    }

References ILIAS\DI\HTTPServices\response().

Here is the call graph for this function:

Field Documentation

◆ $cookieJarFactory

CookieJarFactory ILIAS\DI\HTTPServices::$cookieJarFactory

private

Definition at line 30 of file HTTPServices.php.

Referenced by ILIAS\DI\HTTPServices\__construct().

◆ $request

ServerRequestInterface ILIAS\DI\HTTPServices::$request

private

Definition at line 42 of file HTTPServices.php.

Referenced by ILIAS\DI\HTTPServices\request(), and ILIAS\DI\HTTPServices\saveRequest().

◆ $requestFactory

RequestFactory ILIAS\DI\HTTPServices::$requestFactory

private

Definition at line 34 of file HTTPServices.php.

Referenced by ILIAS\DI\HTTPServices\__construct().

◆ $response

ResponseInterface ILIAS\DI\HTTPServices::$response

private

Definition at line 46 of file HTTPServices.php.

Referenced by ILIAS\DI\HTTPServices\response(), and ILIAS\DI\HTTPServices\saveResponse().

◆ $responseFactory

ResponseFactory ILIAS\DI\HTTPServices::$responseFactory

private

Definition at line 38 of file HTTPServices.php.

Referenced by ILIAS\DI\HTTPServices\__construct().

◆ $sender

ILIAS\DI\HTTPServices::$sender

private

Definition at line 26 of file HTTPServices.php.

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

src/DI/HTTPServices.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ close()

◆ cookieJar()

◆ request()

◆ response()

◆ saveRequest()

◆ saveResponse()

◆ sendResponse()

Field Documentation

◆ $cookieJarFactory

◆ $request

◆ $requestFactory

◆ $response

◆ $responseFactory

◆ $sender