alexanderpas/http-enum

Maintainers

Details

github.com/alexanderpas/php-http-enum

Source

Issues

Installs: 17 022

Dependents: 1

Suggesters: 0

Security: 0

Stars: 77

Watchers: 3

Forks: 6

Open Issues: 2

1.0.0 2021-09-20 18:53 UTC

Requires

  • php: ^8.1

Requires (Dev)

BSL-1.0 8e96f12de0e7ab1221651463918f64f208b9d65c

  • Alexander Pas <git.woop@dropdev.org>

This package is auto-updated.

Last update: 2024-04-16 18:28:37 UTC

README

PHP Version Require Latest Stable Version Latest Unstable Version License

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)

Requirements

  • PHP 8.1 or above

Installation

Composer:

composer require alexanderpas/http-enum

Manually (Without Composer):

include the 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.

Available Enums and Enum methods

All available Enums live in the \Alexanderpas\Common\HTTP namespace.

  • HTTP Methods are represented by the \Alexanderpas\Common\HTTP\Method enum.
  • HTTP Status Codes are represented by the \Alexanderpas\Common\HTTP\StatusCode enum.
  • HTTP Reason Phrases are represented by the \Alexanderpas\Common\HTTP\ReasonPhrase enum.

In addition to the Enum methods available by default on Backed Enums, the following Enum methods are available.

  • Method::fromName(string $name): Method Gives back a HTTP method enum when provided with a valid uppercase HTTP method. (such as 'GET' or 'POST')
  • StatusCode::fromInteger(int $integer): StatusCode Gives back a HTTP Status Code enum when provided with a valid HTTP status code as integer. (such as 200 or 404)
  • StatusCode::fromName(string $name): StatusCode Gives back a HTTP Status Code enum when provided with a valid HTTP status code as a HTTP_ prefixed string. (such as 'HTTP_200' or 'HTTP_404')
  • ReasonPhrase::fromInteger(int $integer): ReasonPhrase Gives back a HTTP Reason Phrase enum when provided with a valid HTTP status code as integer. (such as 200 or 404)
  • ReasonPhrase::fromName(string $name): ReasonPhrase Gives back a HTTP Reason Phrase enum when provided with a valid HTTP status code as a HTTP_ prefixed string. (such as 'HTTP_200' or 'HTTP_404')

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): ReasonPhrase changes a Status Code enum into the corresponding Reason Phrase enum.
  • StatusCode::fromReasonPhrase(ReasonPhrase $reasonPhrase): StatusCode changes 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.

License

Copyright Alexander Pas 2021. Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)

Notes