OkResponse.php

Go to the documentation of this file.

<?php

namespace Elgg\Http;

use InvalidArgumentException;

class OkResponse implements ResponseBuilder {

    protected $content;

    protected $status_code;

    protected $forward_url;

    protected $headers;

    public function __construct($content = '', $status_code = ELGG_HTTP_OK, $forward_url = null) {
        $this->setContent($content);
        $this->setStatusCode($status_code);
        $this->setForwardURL($forward_url);
    }

    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 setStatusCode($status_code = ELGG_HTTP_OK) {
        if (isset($status_code) && (!is_numeric($status_code) || $status_code < 100 || $status_code > 599)) {
            throw new InvalidArgumentException(__METHOD__ . ' expects a valid HTTP status code');
        }
        $this->status_code = (int) $status_code;
        return $this;
    }

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

    public function setForwardURL($forward_url = REFERRER) {
        if (isset($forward_url) && !is_string($forward_url) && $forward_url !== REFERRER) {
            throw new InvalidArgumentException(__METHOD__ . ' expects a valid URL or REFERRER');
        }
        $this->forward_url = $forward_url;
        return $this;
    }

    public function getForwardURL() {
        return $this->forward_url;
    }

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

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