HttpResponse.php

<?php

/**
 * Copyright (c) 2016 RhubarbPHP.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Rhubarb\Crown\Http;

use Rhubarb\Crown\Application;
use Rhubarb\Crown\PhpContext;
use Rhubarb\Crown\Request\Request;

class HttpResponse
{
    private $headers = [];

    private $responseBody = "";
    private $responseCode = "";

    public function getHeader($header, $defaultValue = null)
    {
        return (isset($this->headers[$header])) ? $this->headers[$header] : $defaultValue;
    }

    public function setHeaders($headers)
    {
        $this->headers = $headers;
    }

    /**
     * @param string $responseBody
     */
    public function setResponseBody($responseBody)
    {
        $this->responseBody = $responseBody;
    }

    /**
     * @return string
     */
    public function getResponseBody()
    {
        return $this->responseBody;
    }

    /**
     * @param string $name Cookie name
     * @param string $value Cookie value
     * @param int $expirySecondsFromNow Time the cookie should last for in seconds. Defaults to 2 weeks. Pass null to make this a session cookie.
     * @param string $path Web path the cookie should be available to - defaults to "/", the whole site
     * @param string $domain Domain the cookie should be available to - defaults to current subdomain. Set to ".domain.com" to make available to all subdomains.
     * @param bool $secure Indicates that the cookie should only be transmitted via HTTPS - defaults to false
     * @param bool $httpOnly Indicates that the cookie should only be transmitted via the HTTP Protocol - defaults to false
     * @param string $sameSite Indicates the SameSite attribute of the cookie. Can be "Strict", "Lax" or "None" - defaults to "Lax".
     */
    public static function setCookie($name, $value, $expirySecondsFromNow = 1209600, $path = "/", $domain = null, $secure = false, $httpOnly = false, $sameSite = "Lax")
    {
        if ($expirySecondsFromNow != null){
            $expirySecondsFromNow = time() + $expirySecondsFromNow;
        } else {
            $expirySecondsFromNow = 0;
        }

        if (!Application::current()->unitTesting) {
            setcookie($name, $value, [
                'expires' => $expirySecondsFromNow,
                'path' => $path,
                'domain' => $domain,
                'secure' => $secure,
                'httponly' => $httpOnly,
                'samesite' => $sameSite
            ]);
        }

        $request = Request::current();
        $request->cookieData[$name] = $value;
    }

    /**
     * @param string $name Cookie name
     * @param string $path Web path the cookie should be available to - defaults to "/", the whole site
     * @param string $domain Domain the cookie should be available to - defaults to current subdomain. Set to ".domain.com" to make available to all subdomains.
     * @param bool $secure Indicates that the cookie should only be transmitted via HTTPS - defaults to false
     * @param bool $httpOnly Indicates that the cookie should only be transmitted via the HTTP Protocol - defaults to false
     * @param string $sameSite Indicates the SameSite attribute of the cookie. Can be "Strict", "Lax" or "None" - defaults to "Lax".
     */
    public static function unsetCookie($name, $path = "/", $domain = null, $secure = false, $httpOnly = false, $sameSite = "Lax")
    {
        self::setCookie($name, null, -1000, $path, $domain, $secure, $httpOnly, $sameSite);
    }

    /**
     * @return string
     */
    public function getResponseCode()
    {
        return $this->responseCode;
    }

    /**
     * @param string $responseCode
     */
    public function setResponseCode($responseCode)
    {
        $this->responseCode = $responseCode;
    }

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

    public function isRedirect()
    {
        return $this->responseCode >= 300 && $this->responseCode <= 399;
    }

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

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