Response.php

Go to the documentation of this file.

<?php

namespace Elgg\Http;

use Elgg\Exceptions\InvalidArgumentException;
use Elgg\Exceptions\RangeException;

abstract class Response implements ResponseBuilder {

    protected $content;

    protected int $status_code;

    protected ?string $forward_url = null;

    protected array $headers = [];

    protected ?\Exception $exception = null;
    
    protected bool $secure_forward_url = true;

    public function setContent($content = '') {
        if (isset($content) && !is_scalar($content) && !is_array($content)) {
            throw new InvalidArgumentException(__METHOD__ . ' expects content as a scalar value or array');
        }
        
        $this->content = $content;
        return $this;
    }

    public function getContent() {
        return $this->content;
    }

    public function setException(\Exception $e) {
        $this->exception = $e;
        return $this;
    }

    public function getException() {
        return $this->exception;
    }

    public function setStatusCode(int $status_code) {
        if ($status_code < 100 || $status_code > 599) {
            throw new RangeException(__METHOD__ . ' expects a valid HTTP status code');
        }
        
        $this->status_code = $status_code;
        return $this;
    }

    public function getStatusCode() {
        return $this->status_code;
    }

    public function setForwardURL(string $forward_url = REFERRER) {
        $this->forward_url = $forward_url;
        return $this;
    }

    public function getForwardURL(): ?string {
        if (!isset($this->forward_url)) {
            return null;
        }
            
        $forward_url = $this->forward_url;
        if ($forward_url === REFERRER || !$this->secure_forward_url) {
            return $forward_url;
        }
        
        return elgg_normalize_site_url($forward_url) !== null ? $forward_url : '';
    }

    public function setHeaders(array $headers = []) {
        $this->headers = $headers;
        return $this;
    }

    public function getHeaders() {
        return $this->headers;
    }

    public function isInformational() {
        return $this->status_code >= 100 && $this->status_code <= 199;
    }

    public function isSuccessful() {
        return $this->status_code >= 200 && $this->status_code <= 299;
    }

    public function isOk() {
        return $this->status_code === 200;
    }

    public function isRedirection() {
        return in_array($this->status_code, [201, 301, 302, 303, 307, 308]);
    }

    public function isClientError() {
        return $this->status_code >= 400 && $this->status_code <= 499;
    }

    public function isServerError() {
        return $this->status_code >= 500 && $this->status_code <= 599;
    }

    public function isNotModified() {
        return $this->status_code === 304;
    }
}