ILIAS\DI\HTTPServices Class Reference

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 ()
	request ()
	response ()
	saveRequest (ServerRequestInterface $request)
	saveResponse (ResponseInterface $response)
	sendResponse ()
	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 34 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 71 of file HTTPServices.php.

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

    {
        $this->sender = $senderStrategy;
        $this->cookieJarFactory = $cookieJarFactory;

        $this->requestFactory = $requestFactory;
        $this->responseFactory = $responseFactory;
    }

Member Function Documentation

close()

ILIAS\DI\HTTPServices::close

(

)

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 147 of file HTTPServices.php.

References exit.

                            : void
    {
        exit;
    }

cookieJar()

ILIAS\DI\HTTPServices::cookieJar

(

)

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 84 of file HTTPServices.php.

References ILIAS\DI\HTTPServices\response().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

request()

ILIAS\DI\HTTPServices::request

(

)

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 93 of file HTTPServices.php.

References ILIAS\DI\HTTPServices\$request.

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

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

        return $this->request;
    }

Here is the caller graph for this function:

response()

ILIAS\DI\HTTPServices::response

(

)

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 106 of file HTTPServices.php.

References ILIAS\DI\HTTPServices\$response.

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

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

        return $this->response;
    }

Here is the caller graph for this function:

saveRequest()

ILIAS\DI\HTTPServices::saveRequest

(

ServerRequestInterface

$request

)

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 119 of file HTTPServices.php.

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

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

Here is the call graph for this function:

saveResponse()

ILIAS\DI\HTTPServices::saveResponse

(

ResponseInterface

$response

)

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 128 of file HTTPServices.php.

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

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

Here is the call graph for this function:

sendResponse()

ILIAS\DI\HTTPServices::sendResponse

(

)

Implements ILIAS\HTTP\GlobalHttpState.

Definition at line 137 of file HTTPServices.php.

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

                                   : void
    {
        // Render Cookies to the response.
        $response = $this->response();
        $response = $this->cookieJar()->renderIntoResponseHeader($response);
        
        $this->sender->sendResponse($response);
    }

Here is the call graph for this function:

Field Documentation

$cookieJarFactory

CookieJarFactory ILIAS\DI\HTTPServices::$cookieJarFactory

private

Definition at line 44 of file HTTPServices.php.

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

$request

ServerRequestInterface ILIAS\DI\HTTPServices::$request

private

Definition at line 56 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 48 of file HTTPServices.php.

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

$response

ResponseInterface ILIAS\DI\HTTPServices::$response

private

Definition at line 60 of file HTTPServices.php.

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

$responseFactory

ResponseFactory ILIAS\DI\HTTPServices::$responseFactory

private

Definition at line 52 of file HTTPServices.php.

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

$sender

ILIAS\DI\HTTPServices::$sender

private

Definition at line 40 of file HTTPServices.php.

---

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

• src/DI/HTTPServices.php