MarcAndreAppel\HttpStatus\HttpStatus

Complexity

Total Complexity

8

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setProtocol()	0	6	2
A	__construct()	0	16	4
A	header()	0	7	2

<?php
/**
 * HttpStatusModel.php
 * @author      Marc-André Appel <marc-andre@hybride-conseil.fr>
 * @copyright   2018 Hybride Conseil
 * @license     http://opensource.org/licenses/MIT MIT
 * @link        https://www.hybride-conseil.fr
 * @created     19/06/2018
 */

declare(strict_types=1);

namespace MarcAndreAppel\HttpStatus;

use MarcAndreAppel\HttpStatus\Exceptions\HeaderSentException;

class HttpStatus
{
	public $code;
	public $title;
	public $message;

	private $version = 1.0;

	private static $titles = array(
		100 => "Continue",
		101 => "Switching Protocols",
		102 => "Processing",
		103 => "Early Hints",

		200 => "OK",
		201 => "Created",
		202 => "Accepted",
		203 => "Non-Authoritative Information",
		204 => "No Content",
		205 => "Reset Content",
		206 => "Partial Content",
		207 => "Multi-Status",
		208 => "Already Reported",
		226 => "IM Used",

		300 => "Multiple Choices",
		301 => "Moved Permanently",
		302 => "Found",
		303 => "See Other",
		304 => "Not Modified",
		305 => "Use Proxy",
		307 => "Temporary Redirect",
		308 => "Permanent Redirect",

		400 => "Bad Request",
		401 => "Unauthorized",
		402 => "Payment Required",
		403 => "Forbidden",
		404 => "Not Found",
		405 => "Method Not Allowed",
		406 => "Not Acceptable",
		407 => "Proxy Authentication Required",
		408 => "Request Timeout",
		409 => "Conflict",
		410 => "Gone",
		411 => "Length Required",
		412 => "Precondition Failed",
		413 => "Payload Too Large",
		414 => "URI Too Long",
		415 => "Unsupported Media Type",
		416 => "Range Not Satisfiable",
		417 => "Expectation Failed",
		418 => "I\'m a teapot",
		421 => "Misdirected Request",
		422 => "Unprocessable Entity",
		423 => "Locked",
		424 => "Failed Dependency",
		425 => "Reserved for WebDAV advanced collections expired proposal",
		426 => "Upgrade Required",
		428 => "Precondition Required",
		429 => "Too Many Requests",
		431 => "Request Header Fields Too Large",
		451 => "Unavailable For Legal Reasons",
		
		500 => "Internal Server Error",
		501 => "Not Implemented",
		502 => "Bad Gateway",
		503 => "Service Unavailable",
		504 => "Gateway Timeout",
		505 => "HTTP Version Not Supported",
		506 => "Variant Also Negotiates",
		507 => "Insufficient Storage",
		508 => "Loop Detected",
		510 => "Not Extended",
		511 => "Network Authentication Required",
	);

	private static $messages = array(
		200 => "Standard response for successful HTTP requests.",
		201 => "The request has been fulfilled, resulting in the creation of a new resource.",
		202 => "The request has been accepted for processing, but the processing has not been completed.",
		203 => "The server is a transforming proxy (e.g. a Web accelerator) that received a 200 OK from its origin, but is returning a modified version of the origin\"s response.",
		204 => "The server successfully processed the request and is not returning any content.",
		205 => "The server successfully processed the request, but is not returning any content.",
		206 => "The server is delivering only part of the resource (byte serving) due to a range header sent by the client.",
		207 => "The message body that follows is an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.",
		208 => "The members of a DAV binding have already been enumerated in a previous reply to this request, and are not being included again.",
		226 => "The server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.",
		
		300 => "Indicates multiple options for the resource from which the client may choose.",
		301 => "This and all future requests should be directed to the given URI.",
		302 => "This is an example of industry practice contradicting the standard.",
		303 => "The response to the request can be found under another URI using a GET method.",
		304 => "Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match.",
		305 => "The requested resource is available only through a proxy, the address for which is provided in the response.",
		306 => "No longer used.",
		307 => "In this case, the request should be repeated with another URI; however, future requests should still use the original URI.",
		308 => "The request and all future requests should be repeated using another URI.",
		
		400 => "The request cannot be fulfilled due to bad syntax.",
		401 => "Authentication is required and has failed or has not yet been provided.",
		402 => "Reserved for future use.",
		403 => "The request was a valid request, but the server is refusing to respond to it.",
		404 => "The requested resource could not be found but may be available again in the future.",
		405 => "A request was made of a resource using a request method not supported by that resource.",
		406 => "The requested resource is only capable of generating content not acceptable.",
		407 => "Proxy authentication is required to access the requested resource.",
		408 => "The server did not receive a complete request message in time.",
		409 => "The request could not be processed because of conflict in the request.",
		410 => "The requested resource is no longer available and will not be available again.",
		411 => "The request did not specify the length of its content, which is required by the resource.",
		412 => "The server does not meet one of the preconditions that the requester put on the request.",
		413 => "The server cannot process the request because the request payload is too large.",
		414 => "The request-target is longer than the server is willing to interpret.",
		415 => "The request entity has a media type which the server or resource does not support.",
		416 => "The client has asked for a portion of the file, but the server cannot supply that portion.",
		417 => "The expectation given could not be met by at least one of the inbound servers.",
		418 => "I\'m a teapot",
		421 => "The request was directed at a server that is not able to produce a response.",
		422 => "The request was well-formed but was unable to be followed due to semantic errors.",
		423 => "The resource that is being accessed is locked.",
		424 => "The request failed due to failure of a previous request.",
		426 => "The server cannot process the request using the current protocol.",
		428 => "The origin server requires the request to be conditional.",
		429 => "The user has sent too many requests in a given amount of time.",
		431 => "The server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.",
		451 => "Resource access is denied for legal reasons.",
		
		500 => "An error has occurred and this resource cannot be displayed.",
		501 => "The server either does not recognize the request method, or it lacks the ability to fulfil the request.",
		502 => "The server was acting as a gateway or proxy and received an invalid response from the upstream server.",
		503 => "The server is currently unavailable. It may be overloaded or down for maintenance.",
		504 => "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.",
		505 => "The server does not support the HTTP protocol version used in the request.",
		506 => "Transparent content negotiation for the request, results in a circular reference.",
		507 => "The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. There is insufficient free space left in your storage allocation.",
		508 => "The server detected an infinite loop while processing the request.",
		510 => "Further extensions to the request are required for the server to fulfill it.A mandatory extension policy in the request is not accepted by the server for this resource.",
		511 => "The client needs to authenticate to gain network access.",
	);

	public function __construct(int $code = null)
	{
		if (is_null($code)) {
			throw new \InvalidArgumentException("Cannot be null nor empty");
		}
		if ( ! key_exists($code, self::$titles) || ! is_int($code)) {
			throw new \OutOfBoundsException("Not a valid integer or not a valid HTTP status code");
		}

		$this->code = $code;
		$this->title = self::$titles[$code];
		$this->message = self::$messages[$code] ?? null;

		$this->setProtocol();

		return $this;
	}


	/**
	 * @throws \MarcAndreAppel\HttpStatus\Exceptions\HeaderSentException
	 */
	public function header()
	{
		if (headers_sent()) {
			throw new HeaderSentException();
		} else {
			$header = sprintf("HTTP/%s %s %s", $this->version, $this->code, $this->title);
			header($header, true, $this->code);
		}
	}

	private function setProtocol()
	{
		if ("HTTP/1.0" != $_SERVER['SERVER_PROTOCOL']) {
			$this->version = 1.1;
		}
		return $this;
	}
}