xylemical/http

Provides processing of HTTP structured fields according to RFC8941.

dev-master 2022-04-19 03:01 UTC

Requires

• php: >=8.0

Requires (Dev)

• christian-riesen/base32: ^1.6
• dealerdirect/phpcodesniffer-composer-installer: ^0.7.0
• drupal/coder: ^8.3
• httpwg/structured-field-tests: dev-main
• phpspec/prophecy-phpunit: ^2.0
• phpstan/phpstan: ^0.12.48
• phpunit/phpunit: ^9.3
• squizlabs/php_codesniffer: ^3.5

MIT

• php
• http
• structured fields
• rfc8941

README

Provides for parsing and serializing structured fields according to RFC8941.

Install

The recommended way to install this library is through composer.

composer require xylemical/http

Usage

<?php

use Xylemical\Http;

use Xylemical\Http\Field;

$request = ...; // Using Psr\Http\Message\RequestInterface

$header = Field::parse('list', $request->getHeaderLine('Accept'));
$header = Field::parse('item', $request->getHeaderLine('Origin'));
$header = Field::parse('dictionary', $request->getHeaderLine());
$value = $header->toInternal(); // All structured fields support toInternal().

// Example of a list header.
$header = Field::fromInternal(['application/json', 'application/xml']);

print $header[0];     // prints 'application/json';
print count($header); // prints 2.

// Example of a dictionary header.
$header = Field::fromInternal(['q' => 'foo', 't' => 'bar']);

print_r($header['q']); // prints ['foo']

// Manipulate the parameters for the 'q' map entry.
$header->get('q')
  ->getParameters()
  ->set('test' => 'bar');

print_r($header['q']);  // ['foo', '@attributes' => ['test' => 'bar']]

print $header->get('q')->toInternal(); // prints 'foo'

// Example of creation of the 'Content-Type' header. 
$header = Item::fromIternal([
  'application/json', 
  '@attributes' => ['content-encoding' => 'utf-8']
]);

// When using Item.
print $header->getValue();  // prints 'application/json'
print (string)$header;      // prints 'application/json; content-encoding=utf-8'
print $header->serialize(); // will throw SyntaxException if data in header invalid. 

License

MIT, see LICENSE.