ICanBoogie
  • Documentation
  • API Reference
  • HTTP v2.6.0
Namespaces
  • ICanBoogie
    • Exception
    • HTTP
      • Headers
      • Request
      • RequestDispatcher
Classes
  • CallableDispatcher
  • DispatcherProvider
  • File
  • FileInfo
  • FileList
  • FileResponse
  • Headers
  • ProvideDispatcher
  • RedirectResponse
  • Request
  • RequestDispatcher
  • RequestOptionsMapper
  • RequestRange
  • Response
  • Status
  • WeightedDispatcher
Interfaces
  • Dispatcher
  • Exception
  • FileOptions
  • RequestMethods
  • RequestOptions
  • ResponseStatus
  • SecurityError
Exceptions
  • AuthenticationRequired
  • ClientError
  • DispatcherNotDefined
  • DispatcherProviderNotDefined
  • ForceRedirect
  • MethodNotSupported
  • NotFound
  • PermissionRequired
  • ServerError
  • ServiceUnavailable
  • StatusCodeNotValid

Class Status

Class Status

ICanBoogie\HTTP\Status uses ICanBoogie\Accessor\AccessorTrait (not available)
Namespace: ICanBoogie\HTTP
Located at Status.php

Methods summary

public static from( $status ) : ICanBoogie\HTTP\Status

Creates a new instance from the provided status.

Creates a new instance from the provided status.

Parameters

$status

Returns

ICanBoogie\HTTP\Status

Throws

InvalidArgumentException
When the HTTP status code is not valid.
protected set_code( $code )
protected get_code( void )
protected get_is_valid( void ) : boolean

Whether the status is valid.

Whether the status is valid.

A status is considered valid when its code is between 100 and 600, 100 included.

Returns

boolean
protected get_is_informational( void ) : boolean

Whether the status is informational.

Whether the status is informational.

A status is considered informational when its code is between 100 and 200, 100 included.

Returns

boolean
protected get_is_successful( void ) : boolean

Whether the status is successful.

Whether the status is successful.

A status is considered successful when its code is between 200 and 300, 200 included.

Returns

boolean
protected get_is_redirect( void ) : boolean

Whether the status is a redirection.

Whether the status is a redirection.

A status is considered to be a redirection when its code is between 300 and 400, 300 included.

Returns

boolean
protected get_is_client_error( void ) : boolean

Whether the status is a client error.

Whether the status is a client error.

A status is considered a client error when its code is between 400 and 500, 400 included.

Returns

boolean
protected get_is_server_error( void ) : boolean

Whether the status is a server error.

Whether the status is a server error.

A status is considered a server error when its code is between 500 and 600, 500 included.

Returns

boolean
protected get_is_ok( void ) : boolean

Whether the status is ok.

Whether the status is ok.

A status is considered ok when its code is ICanBoogie\HTTP\Status::OK.

Returns

boolean
protected get_is_forbidden( void ) : boolean

Whether the status is forbidden.

Whether the status is forbidden.

A status is considered forbidden ok when its code is ICanBoogie\HTTP\Status::FORBIDDEN.

Returns

boolean
protected get_is_not_found( void ) : boolean

Whether the status is not found.

Whether the status is not found.

A status is considered not found when its code is ICanBoogie\HTTP\Status::NOT_FOUND.

Returns

boolean
protected get_is_empty( void ) : boolean

Whether the status is empty.

Whether the status is empty.

A status is considered empty when its code is ICanBoogie\HTTP\Status::CREATED, ICanBoogie\HTTP\Status::NO_CONTENT or ICanBoogie\HTTP\Status::NOT_MODIFIED.

Returns

boolean
protected get_is_cacheable( void ) : boolean

Whether the status is cacheable.

Whether the status is cacheable.

Returns

boolean
protected set_message( $message )
protected get_message( void )
public __construct( integer $code = self::OK, string|null $message = null )

Parameters

$code
$message
public __toString( void )

Constants summary

CONTINUE_ : integer 
100
SWITCHING_PROTOCOLS : integer 
101
OK : integer 
200
CREATED : integer 
201
ACCEPTED : integer 
202
NON_AUTHORITATIVE_INFORMATION : integer 
203
NO_CONTENT : integer 
204
RESET_CONTENT : integer 
205
PARTIAL_CONTENT : integer 
206
MULTIPLE_CHOICES : integer 
300
MOVED_PERMANENTLY : integer 
301
FOUND : integer 
302
SEE_OTHER : integer 
303
NOT_MODIFIED : integer 
304
USE_PROXY : integer 
305
TEMPORARY_REDIRECT : integer 
307
BAD_REQUEST : integer 
400
UNAUTHORIZED : integer 
401
PAYMENT_REQUIRED : integer 
402
FORBIDDEN : integer 
403
NOT_FOUND : integer 
404
METHOD_NOT_ALLOWED : integer 
405
NOT_ACCEPTABLE : integer 
406
PROXY_AUTHENTICATION_REQUIRED : integer 
407
REQUEST_TIMEOUT : integer 
408
CONFLICT : integer 
409
GONE : integer 
410
LENGTH_REQUIRED : integer 
411
PRECONDITION_FAILED : integer 
412
REQUEST_ENTITY_TOO_LARGE : integer 
413
REQUEST_URI_TOO_LONG : integer 
414
UNSUPPORTED_MEDIA_TYPE : integer 
415
REQUESTED_RANGE_NOT_SATISFIABLE : integer 
416
EXPECTATION_FAILED : integer 
417
I_M_A_TEAPOT : integer 
418
INTERNAL_SERVER_ERROR : integer 
500
NOT_IMPLEMENTED : integer 
501
BAD_GATEWAY : integer 
502
SERVICE_UNAVAILABLE : integer 
503
GATEWAY_TIMEOUT : integer 
504
HTTP_VERSION_NOT_SUPPORTED : integer 
505

Properties summary

public static $codes_and_messages : array

HTTP status codes and messages.

HTTP status codes and messages.

[

    100 => "Continue",
    101 => "Switching Protocols",

    200 => "OK",
    201 => "Created",
    202 => "Accepted",
    203 => "Non-Authoritative Information",
    204 => "No Content",
    205 => "Reset Content",
    206 => "Partial Content",

    300 => "Multiple Choices",
    301 => "Moved Permanently",
    302 => "Found",
    303 => "See Other",
    304 => "Not Modified",
    305 => "Use Proxy",
    307 => "Temporary 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 => "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",

    500 => "Internal Server Error",
    501 => "Not Implemented",
    502 => "Bad Gateway",
    503 => "Service Unavailable",
    504 => "Gateway Timeout",
    505 => "HTTP Version Not Supported"

]

Magic properties

public $code : integer
public $message : string
public read-only $is_cacheable : boolean

Whether the status is cacheable.

public read-only $is_client_error : boolean

Whether the status is a client error.

public read-only $is_empty : boolean

Whether the status is empty.

public read-only $is_forbidden : boolean

Whether the status is forbidden.

public read-only $is_informational : boolean

Whether the status is informational.

public read-only $is_not_found : boolean

Whether the status is not found.

public read-only $is_ok : boolean

Whether the status is ok.

public read-only $is_redirect : boolean

Whether the status is a redirection.

public read-only $is_server_error : boolean

Whether the status is a server error.

public read-only $is_successful : boolean

Whether the status is successful.

public read-only $is_valid : boolean

Whether the status is valid.

HTTP v2.6.0 – Check on GitHub – API documentation generated by ApiGen