This package provides HTTP Methods, Status Codes and Reason Phrases as PHP 8.1+ enums
All IANA registered HTTP Status codes and corresponding Reason Phrases as of the latest update on 2018-09-21 are supported.
This includes the HTTP Methods defined in RFC 5789 and RFC 7231, as well as all Status Codes and Reason Phrases as defined in HTTP/1.1 (RFC 7231, RFC 7232, RFC 7233, RFC 7235) and HTTP/2 (RFC 7540) as well as other RFC's defining HTTP status codes such as WebDAV (RFC 2518, RFC 4918, RFC 5842, RFC 8144) and more (RFC 8297, RFC 3229, RFC 7538, RFC 7694, RFC 6585, RFC 7725, RFC 2295, RFC 2774)
- PHP 8.1 or above
composer require alexanderpas/http-enum
src/Method.php file in order to use the HTTP methods enum.
include both the
src/ReasonPhrase.php file as well as the
src/StatusCode.php file in order to use the HTTP Status Code enum or the HTTP Reason Phrase enum.
All available Enums live in the
- HTTP Methods are represented by the
- HTTP Status Codes are represented by the
- HTTP Reason Phrases are represented by the
In addition to the Enum methods available by default on Backed Enums, the following Enum methods are available.
Method::fromName(string $name): MethodGives back a HTTP method enum when provided with a valid uppercase HTTP method. (such as
StatusCode::fromInteger(int $integer): StatusCodeGives back a HTTP Status Code enum when provided with a valid HTTP status code as integer. (such as
StatusCode::fromName(string $name): StatusCodeGives back a HTTP Status Code enum when provided with a valid HTTP status code as a
HTTP_prefixed string. (such as
ReasonPhrase::fromInteger(int $integer): ReasonPhraseGives back a HTTP Reason Phrase enum when provided with a valid HTTP status code as integer. (such as
ReasonPhrase::fromName(string $name): ReasonPhraseGives back a HTTP Reason Phrase enum when provided with a valid HTTP status code as a
HTTP_prefixed string. (such as
All of the above methods also have a try variant (such as
Method::tryFromName(?string $name): ?Method), which returns
null if an invalid value of the correct type has been given instead of thowing an exception.
Additionally, you can change between Status Code enums and Reason Phrase enums using the following methods:
ReasonPhrase::fromStatusCode(StatusCode $statusCode): ReasonPhrasechanges a Status Code enum into the corresponding Reason Phrase enum.
StatusCode::fromReasonPhrase(ReasonPhrase $reasonPhrase): StatusCodechanges a Reason Phrase enum into the corresponding Status Code enum.
These methods do not have a try variant.
You can get the respective string or integer representation as usual by reading the
value attribute on the enum.
- Support for the HTTP status code 306 has intentionally been removed as it has been defined as Unused in RFC 7231, Section 6.4.6
- The Methods, Status Codes and Reason Phrases defined in the Hyper Text Coffee Pot Control Protocol (RFC 2324) are not supported as they aren't properly registered and provide Methods unique to that specific protocol.
- The Request Methods specific to WebDAV are not supported.