Borobudur\Http\HttpStatus

Complexity

Total Complexity

19

Size/Duplication

Total Lines	280
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getStatusText()	0	12	3
A	isValid()	0	4	2
A	isInformational()	0	4	2
A	isSuccessful()	0	4	2
A	isRedirection()	0	4	2
A	isClientError()	0	4	2
A	isServerError()	0	4	2
A	isOk()	0	4	1
A	isForbidden()	0	4	1
A	isNotFound()	0	4	1
A	isEmpty()	0	4	1

<?php
/*
 * This file is part of the Borobudur-Http package.
 *
 * (c) Hexacodelabs <http://hexacodelabs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Borobudur\Http;

use Borobudur\Http\Exception\InvalidArgumentException;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     7/30/15
 */
class HttpStatus
{
    /**
     * @const int Status codes
     */
    const HTTP_CONTINUE = 100;
    const HTTP_SWITCHING_PROTOCOLS = 101;
    const HTTP_PROCESSING = 102;            // RFC2518
    const HTTP_OK = 200;
    const HTTP_CREATED = 201;
    const HTTP_ACCEPTED = 202;
    const HTTP_NON_AUTHORITATIVE_INFORMATION = 203;
    const HTTP_NO_CONTENT = 204;
    const HTTP_RESET_CONTENT = 205;
    const HTTP_PARTIAL_CONTENT = 206;
    const HTTP_MULTI_STATUS = 207;
    const HTTP_ALREADY_REPORTED = 208;
    const HTTP_IM_USED = 226;
    const HTTP_MULTIPLE_CHOICES = 300;
    const HTTP_MOVED_PERMANENTLY = 301;
    const HTTP_FOUND = 302;
    const HTTP_SEE_OTHER = 303;
    const HTTP_NOT_MODIFIED = 304;
    const HTTP_USE_PROXY = 305;
    const HTTP_RESERVED = 306;
    const HTTP_TEMPORARY_REDIRECT = 307;
    const HTTP_PERMANENTLY_REDIRECT = 308;
    const HTTP_BAD_REQUEST = 400;
    const HTTP_UNAUTHORIZED = 401;
    const HTTP_PAYMENT_REQUIRED = 402;
    const HTTP_FORBIDDEN = 403;
    const HTTP_NOT_FOUND = 404;
    const HTTP_METHOD_NOT_ALLOWED = 405;
    const HTTP_NOT_ACCEPTABLE = 406;
    const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407;
    const HTTP_REQUEST_TIMEOUT = 408;
    const HTTP_CONFLICT = 409;
    const HTTP_GONE = 410;
    const HTTP_LENGTH_REQUIRED = 411;
    const HTTP_PRECONDITION_FAILED = 412;
    const HTTP_REQUEST_ENTITY_TOO_LARGE = 413;
    const HTTP_REQUEST_URI_TOO_LONG = 414;
    const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
    const HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
    const HTTP_EXPECTATION_FAILED = 417;
    const HTTP_I_AM_A_TEAPOT = 418;
    const HTTP_UNPROCESSABLE_ENTITY = 422;
    const HTTP_LOCKED = 423;                                                      // RFC4918
    const HTTP_FAILED_DEPENDENCY = 424;                                           // RFC4918
    const HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL = 425;   // RFC2817
    const HTTP_UPGRADE_REQUIRED = 426;                                            // RFC2817
    const HTTP_PRECONDITION_REQUIRED = 428;                                       // RFC6585
    const HTTP_TOO_MANY_REQUESTS = 429;                                           // RFC6585
    const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431;                             // RFC6585
    const HTTP_INTERNAL_SERVER_ERROR = 500;
    const HTTP_NOT_IMPLEMENTED = 501;
    const HTTP_BAD_GATEWAY = 502;
    const HTTP_SERVICE_UNAVAILABLE = 503;
    const HTTP_GATEWAY_TIMEOUT = 504;
    const HTTP_VERSION_NOT_SUPPORTED = 505;
    const HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506;                        // RFC2295
    const HTTP_INSUFFICIENT_STORAGE = 507;                                        // RFC4918
    const HTTP_LOOP_DETECTED = 508;                                               // RFC5842
    const HTTP_NOT_EXTENDED = 510;                                                // RFC2774
    const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511;                             // RFC6585

    /**
     * @var array
     */
    private static $statusTexts = array(
        // Informational Codes
        100 => 'Continue',
        101 => 'Switching Protocols',
        102 => 'Processing',
        // Success Codes
        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',
        // Redirection Codes
        300 => 'Multiple Choices',
        301 => 'Moved Permanently',
        302 => 'Found',
        303 => 'See Other',
        304 => 'Not Modified',
        305 => 'Use Proxy',
        306 => 'Reserved',
        307 => 'Temporary Redirect',
        308 => 'Permanent Redirect',
        // Client Error
        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 => 'Request Entity Too Large',
        414 => 'Request-URI Too Long',
        415 => 'Unsupported Media Type',
        416 => 'Requested Range Not Satisfiable',
        417 => 'Expectation Failed',
        418 => 'I\'m a teapot',
        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',
        // Server Error
        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 (Experimental)',
        507 => 'Insufficient Storage',
        508 => 'Loop Detected',
        510 => 'Not Extended',
        511 => 'Network Authentication Required',
    );

    /**
     * Get HTTP status text by code or return default value if not exist.
     *
     * @param int         $statusCode
     * @param string|null $default
     *
     * @return string
     *
     * @throws InvalidArgumentException
     */
    public static function getStatusText($statusCode, $default = null)
    {
        if (false === is_int($statusCode)) {
            throw new InvalidArgumentException(sprintf('Code should be integer, "%s" given.', gettype($statusCode)));
        }

        if (isset(self::$statusTexts[$statusCode])) {
            return self::$statusTexts[$statusCode];
        }

        return $default;
    }

    /**
     * Check if status code is valid.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isValid($statusCode)
    {
        return (int) $statusCode >= 100 && (int) $statusCode < 600;
    }

    /**
     * Check if status code is informational.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isInformational($statusCode)
    {
        return (int) $statusCode >= 100 && (int) $statusCode < 200;
    }

    /**
     * Check if status code is successful.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isSuccessful($statusCode)
    {
        return (int) $statusCode >= 200 && (int) $statusCode < 300;
    }

    /**
     * Check if status code is redirection.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isRedirection($statusCode)
    {
        return (int) $statusCode >= 300 && (int) $statusCode < 400;
    }

    /**
     * Check if status code is client error.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isClientError($statusCode)
    {
        return (int) $statusCode >= 400 && (int) $statusCode < 500;
    }

    /**
     * Check if status code is server error.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isServerError($statusCode)
    {
        return (int) $statusCode >= 500 && (int) $statusCode < 600;
    }

    /**
     * Check if status code is ok.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isOk($statusCode)
    {
        return 200 === (int) $statusCode;
    }

    /**
     * Check if status code is forbidden.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isForbidden($statusCode)
    {
        return 403 === (int) $statusCode;
    }

    /**
     * Check if status code is not found.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isNotFound($statusCode)
    {
        return 404 === (int) $statusCode;
    }

    /**
     * Check is status code is empty response.
     *
     * @param int $statusCode
     *
     * @return bool
     */
    public static function isEmpty($statusCode)
    {
        return in_array((int) $statusCode, array(204, 304));
    }
}