Collaboration diagram for ilLTIConsumerServiceResponse:

Public Member Functions
	__construct ()
	Class constructor. More...

	getCode ()
	Get the response code. More...

	setCode (int $code)
	Set the response code. More...

	getReason ()
	Get the response reason. More...

	setReason (string $reason)
	Set the response reason. More...

	getRequestMethod ()
	Get the request method. More...

	getAccept ()
	Get the request accept header. More...

	setAccept (string $accept)
	Set the request accept header. More...

	getContentType ()
	Get the response content type. More...

	setContentType (string $contenttype)
	Set the response content type. More...

	getRequestData ()
	Get the request body. More...

	setRequestData (string $data)
	Set the response body. More...

	setBody (string $body)
	Set the response body. More...

	send ($debug=true)
	Add an additional header. More...

Private Attributes
int	$code
	HTTP response code. More...

string	$reason
	HTTP response reason. More...

string	$requestmethod
	HTTP request method. More...

string	$accept
	HTTP request accept header. More...

string	$contenttype
	HTTP response content type. More...

string	$data
	HTTP request body. More...

string	$body
	HTTP response body. More...

array	$responsecodes
	HTTP response codes. More...

array	$additionalheaders
	HTTP additional headers. More...

Detailed Description

Definition at line 29 of file class.ilLTIConsumerServiceResponse.php.

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerServiceResponse::__construct ( )

Class constructor.

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

References $_SERVER.

     {
         $this->code = 200;
         $this->reason = '';
         $this->requestmethod = $_SERVER['REQUEST_METHOD'];
         $this->accept = '';
         $this->contenttype = '';
         $this->data = '';
         $this->body = '';
         $this->responsecodes = array(
             200 => 'OK',
             201 => 'Created',
             202 => 'Accepted',
             300 => 'Multiple Choices',
             400 => 'Bad Request',
             401 => 'Unauthorized',
             402 => 'Payment Required',
             403 => 'Forbidden',
             404 => 'Not Found',
             405 => 'Method Not Allowed',
             406 => 'Not Acceptable',
             415 => 'Unsupported Media Type',
             500 => 'Internal Server Error',
             501 => 'Not Implemented'
         );
         $this->additionalheaders = array();
     }

Member Function Documentation

◆ getAccept()

ilLTIConsumerServiceResponse::getAccept ( )

Get the request accept header.

Definition at line 144 of file class.ilLTIConsumerServiceResponse.php.

References $accept.

                                : string
     {
         return $this->accept;
     }

◆ getCode()

ilLTIConsumerServiceResponse::getCode ( )

Get the response code.

Definition at line 92 of file class.ilLTIConsumerServiceResponse.php.

References $code.

                              : int
     {
         return $this->code;
     }

◆ getContentType()

ilLTIConsumerServiceResponse::getContentType ( )

Get the response content type.

Definition at line 160 of file class.ilLTIConsumerServiceResponse.php.

References $contenttype.

                                     : string
     {
         return $this->contenttype;
     }

◆ getReason()

ilLTIConsumerServiceResponse::getReason ( )

Get the response reason.

Definition at line 109 of file class.ilLTIConsumerServiceResponse.php.

References $code, and $reason.

Referenced by send().

                                : string
     {
         $code = $this->code;
         if (($code < 200) || ($code >= 600)) {
             $code = 500;  // Status code must be between 200 and 599.
         }
         if (empty($this->reason) && array_key_exists($code, $this->responsecodes)) {
             $this->reason = $this->responsecodes[$code];
         }
         // Use generic reason for this category (based on first digit) if a specific reason is not defined.
         if (empty($this->reason)) {
             $this->reason = $this->responsecodes[intval($code / 100) * 100];
         }
         return $this->reason;
     }

Here is the caller graph for this function:

◆ getRequestData()

ilLTIConsumerServiceResponse::getRequestData ( )

Get the request body.

Definition at line 176 of file class.ilLTIConsumerServiceResponse.php.

References $data.

Referenced by ilLTIConsumerGradeServiceScores\execute().

                                     : string
     {
         return $this->data;
     }

Here is the caller graph for this function:

◆ getRequestMethod()

ilLTIConsumerServiceResponse::getRequestMethod ( )

Get the request method.

Definition at line 136 of file class.ilLTIConsumerServiceResponse.php.

References $requestmethod.

                                       : string
     {
         return $this->requestmethod;
     }

◆ send()

ilLTIConsumerServiceResponse::send ( $debug = true )

Add an additional header.

Send the response.

Definition at line 208 of file class.ilLTIConsumerServiceResponse.php.

References $_SERVER, $body, $code, ilObjLTIConsumer\getLogger(), getReason(), and ILIAS\UI\examples\Symbol\Glyph\Header\header().

                                        : void
     {
         header("HTTP/1.0 {$this->code} {$this->getReason()}");
         foreach ($this->additionalheaders as $header) {
             header($header);
         }
         if ($debug) {
             if ($this->code >= 200 && $this->code < 400) {
                 ilObjLTIConsumer::getLogger()->debug("$this->code {$this->getReason()}");
             } else {
                 ilObjLTIConsumer::getLogger()->error("$this->code {$this->getReason()}");
             }
         }
         if ((($this->code >= 200) && ($this->code < 300)) || !empty($this->body)) {
             if (!empty($this->contenttype)) {
                 header("Content-Type: $this->contenttype; charset=utf-8");
             }
             if (!empty($this->body)) {
                 echo $this->body;
             }
         } elseif ($this->code >= 400) {
             header("Content-Type: application/json; charset=utf-8");
             $body = new stdClass();
             $body->status = $this->code;
             $body->reason = $this->getReason();
             $body->request = new stdClass();
             $body->request->method = $_SERVER['REQUEST_METHOD'];
             $body->request->url = $_SERVER['REQUEST_URI'];
             if (isset($_SERVER['HTTP_ACCEPT'])) {
                 $body->request->accept = $_SERVER['HTTP_ACCEPT'];
             }
             if (isset($_SERVER['CONTENT_TYPE'])) {
                 $body->request->contentType = explode(';', $_SERVER['CONTENT_TYPE'], 2)[0];
             }
             echo json_encode($body, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
         }
     }

Here is the call graph for this function:

◆ setAccept()

ilLTIConsumerServiceResponse::setAccept ( string $accept )

Set the request accept header.

Definition at line 152 of file class.ilLTIConsumerServiceResponse.php.

References $accept.

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

◆ setBody()

ilLTIConsumerServiceResponse::setBody ( string $body )

Set the response body.

Definition at line 192 of file class.ilLTIConsumerServiceResponse.php.

References $body.

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

◆ setCode()

ilLTIConsumerServiceResponse::setCode ( int $code )

Set the response code.

Definition at line 100 of file class.ilLTIConsumerServiceResponse.php.

References $code.

Referenced by ilLTIConsumerGradeServiceScores\execute().

                                       : void
     {
         $this->code = $code;
         $this->reason = '';
     }

Here is the caller graph for this function:

◆ setContentType()

ilLTIConsumerServiceResponse::setContentType ( string $contenttype )

Set the response content type.

Definition at line 168 of file class.ilLTIConsumerServiceResponse.php.

References $contenttype.

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

◆ setReason()

ilLTIConsumerServiceResponse::setReason ( string $reason )

Set the response reason.

Definition at line 128 of file class.ilLTIConsumerServiceResponse.php.

References $reason.

Referenced by ilLTIConsumerGradeServiceScores\execute().

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

Here is the caller graph for this function:

◆ setRequestData()

ilLTIConsumerServiceResponse::setRequestData ( string $data )

Set the response body.

Definition at line 184 of file class.ilLTIConsumerServiceResponse.php.

References $data.

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

Field Documentation

◆ $accept

string ilLTIConsumerServiceResponse::$accept

private

HTTP request accept header.

Definition at line 41 of file class.ilLTIConsumerServiceResponse.php.

Referenced by getAccept(), and setAccept().

◆ $additionalheaders

array ilLTIConsumerServiceResponse::$additionalheaders

private

HTTP additional headers.

Definition at line 56 of file class.ilLTIConsumerServiceResponse.php.

◆ $body

string ilLTIConsumerServiceResponse::$body

private

HTTP response body.

Definition at line 50 of file class.ilLTIConsumerServiceResponse.php.

Referenced by send(), and setBody().

◆ $code

int ilLTIConsumerServiceResponse::$code

private

HTTP response code.

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

Referenced by getCode(), getReason(), send(), and setCode().

◆ $contenttype

string ilLTIConsumerServiceResponse::$contenttype

private

HTTP response content type.

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

Referenced by getContentType(), and setContentType().

◆ $data

string ilLTIConsumerServiceResponse::$data

private

HTTP request body.

Definition at line 47 of file class.ilLTIConsumerServiceResponse.php.

Referenced by getRequestData(), and setRequestData().

◆ $reason

string ilLTIConsumerServiceResponse::$reason

private

HTTP response reason.

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

Referenced by getReason(), and setReason().

◆ $requestmethod

string ilLTIConsumerServiceResponse::$requestmethod

private

HTTP request method.

Definition at line 38 of file class.ilLTIConsumerServiceResponse.php.

Referenced by getRequestMethod().

◆ $responsecodes

array ilLTIConsumerServiceResponse::$responsecodes

private

HTTP response codes.

Definition at line 53 of file class.ilLTIConsumerServiceResponse.php.

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

components/ILIAS/LTIConsumer/classes/class.ilLTIConsumerServiceResponse.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAccept()

◆ getCode()

◆ getContentType()

◆ getReason()

◆ getRequestData()

◆ getRequestMethod()

◆ send()

◆ setAccept()

◆ setBody()

◆ setCode()

◆ setContentType()

◆ setReason()

◆ setRequestData()

Field Documentation

◆ $accept

◆ $additionalheaders

◆ $body

◆ $code

◆ $contenttype

◆ $data

◆ $reason

◆ $requestmethod

◆ $responsecodes