README

FyreRequest is a free, open-source immutable HTTP request library for PHP.

Table Of Contents

• Installation
• Basic Usage
• Methods

Installation

Using Composer

composer require fyre/request

In PHP:

use Fyre\Http\Request;

Basic Usage

• $uri is a string or UriInterface and will default to null.
• $options is an array containing the message options.
  • method is a string representing the request method, and will default to "get".
  • body is a string or StreamInterface representing the message body, and will default to "".
  • headers is an array containing headers to set, and will default to [].
  • protocolVersion is a string representing the protocol version, and will default to "1.1".

$request = new Request($uri, $options);

Methods

This class extends the Message class.

Get Method

Get the request method.

$method = $request->getMethod();

Get Request Target

Get the request target.

$requestTarget = $request->getRequestTarget();

Get Uri

Get the request URI.

$uri = $request->getUri();

With Method

Clone the Request with a new method.

• $method is a string representing the request method.

$newRequest = $request->withMethod($method);

With Request Target

Clone the Request with a new request target.

• $requestTarget is a string representing the request target.

$newRequest = $request->withRequestTarget($requestTarget);

With Uri

Clone the Request with a new URI.

• $uri is a UriInterface.
• $preserveHost is a boolean indicating whether to preserve the host header, and will default to false.

$newRequest = $request->withUri($uri, $preserveHost);