class.ilLTIConsumerServiceResponse.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLTIConsumerServiceResponse
{
    private int $code;

    private string $reason;

    private string $requestmethod;

    private string $accept;

    private string $contenttype;

    private string $data;

    private string $body;

    private array $responsecodes;

    private array $additionalheaders;

    public function __construct()
    {
        $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();
    }

    public function getCode(): int
    {
        return $this->code;
    }

    public function setCode(int $code): void
    {
        $this->code = $code;
        $this->reason = '';
    }

    public function getReason(): 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;
    }

    public function setReason(string $reason): void
    {
        $this->reason = $reason;
    }

    public function getRequestMethod(): string
    {
        return $this->requestmethod;
    }

    public function getAccept(): string
    {
        return $this->accept;
    }

    public function setAccept(string $accept): void
    {
        $this->accept = $accept;
    }

    public function getContentType(): string
    {
        return $this->contenttype;
    }

    public function setContentType(string $contenttype): void
    {
        $this->contenttype = $contenttype;
    }

    public function getRequestData(): string
    {
        return $this->data;
    }

    public function setRequestData(string $data): void
    {
        $this->data = $data;
    }

    public function setBody(string $body): void
    {
        $this->body = $body;
    }

    /*
    public function add_additional_header(string $header): void {
        $this->additionalheaders[] = $header;
    }
    */
    public function send($debug = true): 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);
        }
    }
}