corpus / http-message-utils
Utilities for working with Psr7 Http Messages
Installs: 30 192
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 2
Requires
- php: >=7.2
- psr/http-message: ^1 || ^2
Requires (Dev)
- corpus/coding-standard: ^0.6.0
- donatj/drop: ^1.0
- donatj/mddoc: ^0.7.0
- friendsofphp/php-cs-fixer: ^3.3
- guzzlehttp/psr7: ^2.4
- php-mock/php-mock-phpunit: ^2.7
- phpunit/phpunit: ^6.5 || ^9.3
- squizlabs/php_codesniffer: ^3.7
This package is auto-updated.
Last update: 2024-11-04 02:42:52 UTC
README
Utilities for working with PSR-7 Http Message objects.
Requirements
- psr/http-message: ^1 || ^2
- php: >=7.3
Installing
Install the latest version with:
composer require 'corpus/http-message-utils'
Documentation
Class: \Corpus\HttpMessageUtils\Authorization\AuthorizationHeaderParser
Utility to split an Authorization header into <type>
and <credentials>
ala:
Authorization: <type> <credentials>
The parser itself is authorization type agnostic and works with any RFC7235 conforming authorization type.
Example:
$serverRequest = \GuzzleHttp\Psr7\ServerRequest::fromGlobals(); $parsedAuth = (new \Corpus\HttpMessageUtils\Authorization\AuthorizationHeaderParser)->parseServerRequest($serverRequest); if( $parsedAuth ) { echo 'type: ' . $parsedAuth->getType(); echo 'cred: ' . $parsedAuth->getCredentials(); }
Method: AuthorizationHeaderParser->__construct
function __construct([ ?\Corpus\HttpMessageUtils\Authorization\AuthorizationPartsFactory $factory = null])
Parameters:
- \Corpus\HttpMessageUtils\Authorization\AuthorizationPartsFactory | null
$factory
- Optional factory for construction of result objects
Method: AuthorizationHeaderParser->parseString
function parseString(string $headerValue) : ?\Corpus\HttpMessageUtils\Authorization\AuthorizationPartsInterface
Parses an Authorization header into <type>
and <credentials>
Parameters:
- string
$headerValue
- The header value to parse
Returns:
- \Corpus\HttpMessageUtils\Authorization\AuthorizationPartsInterface | null - AuthorizationParts on success, null on failure. Reasons for failure include empty string and non-RFC7235 compliant header values.
Method: AuthorizationHeaderParser->parseServerRequest
function parseServerRequest(\Psr\Http\Message\ServerRequestInterface $request [, string $headerName = self::DEFAULT_HEADER]) : ?\Corpus\HttpMessageUtils\Authorization\AuthorizationPartsInterface
Helper to easily parse from a PSR ServerRequestInterface
Parameters:
- \Psr\Http\Message\ServerRequestInterface
$request
- The PSR ServerRequestInterface to read from - string
$headerName
- Optional header name to parse. Defaults to Authorization.
Returns:
- \Corpus\HttpMessageUtils\Authorization\AuthorizationPartsInterface | null - AuthorizationParts on success, null on failure.
Class: \Corpus\HttpMessageUtils\Authorization\AuthorizationPartsInterface
Representation of the parts of an Authorization Header:
Authorization: <type> <credentials>
Method: AuthorizationPartsInterface->getType
function getType() : string
The specified authorization type
Method: AuthorizationPartsInterface->getCredentials
function getCredentials() : string
The specified authorization credentials
Class: \Corpus\HttpMessageUtils\ProxyAwareSchemer
Utility to map a Uri or ServerRequestInterface's Uri to the external scheme detected from a proxy such as an AWS load balancer.
Will only ever upgrade to https, never downgrade.
Example:
$serverRequest = \GuzzleHttp\Psr7\ServerRequest::fromGlobals(); $serverRequest = (new \Corpus\HttpMessageUtils\ProxyAwareSchemer)->withUriWithDetectedScheme($serverRequest);
<?php namespace Corpus\HttpMessageUtils; class ProxyAwareSchemer { public const HTTPS_EXPECTED_SERVER_VALUES = ['HTTP_X_FORWARDED_PROTOCOL' => 'https', 'HTTP_X_FORWARDED_PROTO' => 'https', 'HTTP_X_FORWARDED_SSL' => 'on', 'HTTP_FRONT_END_HTTPS' => 'on', 'HTTP_X_URL_SCHEME' => 'https', 'HTTPS' => 'on']; public const PORT_EXPECTED_SERVER_KEYS = ['HTTP_X_FORWARDED_PORT']; /** Value for `default port` arguments to remove the port from the URI */ public const REMOVE_PORT = -65536; }
Method: ProxyAwareSchemer->__construct
function __construct([ ?array $server = null [, ?array $proxyServerHttpsKeyValues = null [, ?array $proxyServerPortKeys = null]]])
Parameters:
- array<string,scalar>
$server
- Server array to inspect. Defaults to $_SERVER. - array<string,string> | null
$proxyServerHttpsKeyValues
- Map of $_SERVER keys to their expected https-positive value. Defaults to ProxyAwareSchemer::HTTPS_EXPECTED_SERVER_VALUES - string[] | null
$proxyServerPortKeys
- Array of $_SERVER keys to check for a forwarded port value.
Method: ProxyAwareSchemer->withUriWithDetectedScheme
function withUriWithDetectedScheme(\Psr\Http\Message\ServerRequestInterface $serverRequest [, bool $detectPort = true [, ?int $defaultOnHttps = self::REMOVE_PORT]]) : \Psr\Http\Message\ServerRequestInterface
Given a \Psr\Http\Message\ServerRequestInterface returns a new instance of ServerRequestInterface with a new Uri
having the scheme adjusted to match the detected external scheme as defined by the proxies headers.
Parameters:
- bool
$detectPort
- Enable / Disable proxy port sniffing. - int | null
$defaultOnHttps
- Default port to use if sniffing fails but HTTPS proxy is detected. Defaults to ProxyAwareSchemer::REMOVE_PORT which removes the port information from the URI. Passing null will leave port as-is.
Method: ProxyAwareSchemer->withDetectedScheme
function withDetectedScheme(\Psr\Http\Message\UriInterface $uri [, bool $detectPort = true [, ?int $defaultOnHttps = self::REMOVE_PORT]]) : \Psr\Http\Message\UriInterface
Given a \Psr\Http\Message\UriInterface returns an instance of UriInterface having the scheme adjusted to match
the detected external scheme as defined by the proxies headers.
Parameters:
- bool
$detectPort
- Enable / Disable proxy port sniffing. - int | null
$defaultOnHttps
- Default port to use if sniffing fails but HTTPS proxy is detected. Defaults to ProxyAwareSchemer::REMOVE_PORT which removes the port information from the URI. Passing null will leave port as-is.
Method: ProxyAwareSchemer->withDetectedPort
function withDetectedPort(\Psr\Http\Message\UriInterface $uri [, ?int $default = null]) : \Psr\Http\Message\UriInterface
Given a \Psr\Http\Message\UriInterface returns an instance of UriInterface having the port adjusted to match
the detected external scheme as defined by the proxies headers.
Parameters:
- int | null
$default
- Defines a default fallback port. Passing ProxyAwareSchemer::REMOVE_PORT will default to removing the port information. Defaults to null - null leaves port as-is.
Class: \Corpus\HttpMessageUtils\ResponseSender
Utility to actualize a PSR7 ResponseInterface
Sends headers and body.
Example:
$response = new \GuzzleHttp\Psr7\Response(); (new \Corpus\HttpMessageUtils\ResponseSender)->send($response);
Inspired by http-interop/response-sender
MIT License Copyright (c) 2017 Woody Gilk
Method: ResponseSender->__construct
function __construct([ bool $fullHttpStmtHeader = false [, bool $rewindBody = true]])
ResponseSender constructor.
Parameters:
- bool
$fullHttpStmtHeader
- Setting totrue
enables full HTTP statement construction which allows non-standard reason phrases and potentially mismatched protocol versions. Use with care. - bool
$rewindBody
- Setting tofalse
allows you to disable rewinding the body of the response before transmission.
Method: ResponseSender->send
function send(\Psr\Http\Message\ResponseInterface $response) : void
Trigger the transmission of the given \Psr\Http\Message\ResponseInterface