Class Status

Class Status

ICanBoogie\HTTP\Status uses ICanBoogie\Accessor\AccessorTrait (not available)

Namespace: ICanBoogie\HTTP
Package: ICanBoogie\HTTP
Located at Status.php

Methods summary

`public static ICanBoogie\HTTP\Status`	# `from( $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( )`
`protected boolean`	# `get_is_valid( )` 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 boolean`	# `get_is_informational( )` 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 boolean`	# `get_is_successful( )` 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 boolean`	# `get_is_redirect( )` 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 boolean`	# `get_is_client_error( )` 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 boolean`	# `get_is_server_error( )` 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 boolean`	# `get_is_ok( )` Whether the status is ok. Whether the status is ok. A status is considered ok when its code is 200. Returns boolean
`protected boolean`	# `get_is_forbidden( )` Whether the status is forbidden. Whether the status is forbidden. A status is considered forbidden ok when its code is 403. Returns boolean
`protected boolean`	# `get_is_not_found( )` Whether the status is not found. Whether the status is not found. A status is considered not found when its code is 404. Returns boolean
`protected boolean`	# `get_is_empty( )` Whether the status is empty. Whether the status is empty. A status is considered empty when its code is 201, 204 or 304. Returns boolean
`protected boolean`	# `get_is_cacheable( )` Whether the status is cacheable. Whether the status is cacheable. Returns boolean
`protected`	# `set_message( $message )`
`protected`	# `get_message( )`
`public`	# `__construct( integer $code = 200, string\|null $message = null )` Parameters `$code` `$message`
`public`	# `__toString( )`

Properties summary

`public static array`	`$codes_and_messages` 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 integer`	`$code`
`public string`	`$message`
`public read-only boolean`	`$is_cacheable` Whether the status is cacheable.
`public read-only boolean`	`$is_client_error` Whether the status is a client error.
`public read-only boolean`	`$is_empty` Whether the status is empty.
`public read-only boolean`	`$is_forbidden` Whether the status is forbidden.
`public read-only boolean`	`$is_informational` Whether the status is informational.
`public read-only boolean`	`$is_not_found` Whether the status is not found.
`public read-only boolean`	`$is_ok` Whether the status is ok.
`public read-only boolean`	`$is_redirect` Whether the status is a redirection.
`public read-only boolean`	`$is_server_error` Whether the status is a server error.
`public read-only boolean`	`$is_successful` Whether the status is successful.
`public read-only boolean`	`$is_valid` Whether the status is valid.