\GuzzleHttpPsr7

build_query()

build_query(array  $params, integer|false  $encoding = PHP_QUERY_RFC3986) : string

Build a query string from an array of key value pairs.

This function can use the return value of parse_query() to build a query string. This function does not modify the provided keys when an array is encountered (like http_build_query would).

Parameters

Returns

copy_to_stream()

copy_to_stream(\Psr\Http\Message\StreamInterface  $source, \Psr\Http\Message\StreamInterface  $dest, integer  $maxLen = -1) 

Copy the contents of a stream into another stream until the given number of bytes have been read.

Parameters

Throws

\RuntimeException

on error.

copy_to_string()

copy_to_string(\Psr\Http\Message\StreamInterface  $stream, integer  $maxLen = -1) : string

Copy the contents of a stream into a string until the given number of bytes have been read.

Parameters

Throws

\RuntimeException

on error.

Returns

get_message_body_summary()

get_message_body_summary(\Psr\Http\Message\MessageInterface  $message, integer  $truncateAt = 120) : null|string

Get a short summary of the message body

Will return null if the response is not printable.

Parameters

Returns

hash()

hash(\Psr\Http\Message\StreamInterface  $stream, string  $algo, boolean  $rawOutput = false) : string

Calculate a hash of a Stream

Parameters

Throws

\RuntimeException

on error.

Returns

Returns the hash of the stream

mimetype_from_extension()

mimetype_from_extension(  $extension) : string|null

Maps a file extensions to a mimetype.

Parameters

Returns

mimetype_from_filename()

mimetype_from_filename(  $filename) : null|string

Determines the mimetype of a file by looking at its extension.

Parameters

Returns

modify_request()

modify_request(\Psr\Http\Message\RequestInterface  $request, array  $changes) : \Psr\Http\Message\RequestInterface

Clone and modify a request with the given changes.

The changes can be one of:

• method: (string) Changes the HTTP method.
• set_headers: (array) Sets the given headers.
• remove_headers: (array) Remove the given headers.
• body: (mixed) Sets the given body.
• uri: (UriInterface) Set the URI.
• query: (string) Set the query string value of the URI.
• version: (string) Set the protocol version.

Parameters

Returns

normalize_header()

normalize_header(string|array  $header) : array

Converts an array of header values that may contain comma separated headers into an array of headers with no comma separated values.

Parameters

Returns

Returns the normalized header field values.

parse_header()

parse_header(string|array  $header) : array

Parse an array of header values containing ";" separated data into an array of associative arrays representing the header key value pair data of the header. When a parameter does not contain a value, but just contains a key, this function will inject a key with a '' string value.

Parameters

Returns

Returns the parsed header values.

parse_query()

parse_query(string  $str, integer|boolean  $urlEncoding = true) : array

Parse a query string into an associative array.

If multiple values are found for the same key, the value of that key value pair will become an array. This function does not parse nested PHP style arrays into an associative array (e.g., foo[a]=1&foo[b]=2 will be parsed into ['foo[a]' => '1', 'foo[b]' => '2']).

Parameters

Returns

parse_request()

parse_request(string  $message) : \GuzzleHttp\Psr7\Request

Parses a request message string into a request object.

Parameters

Returns

parse_response()

parse_response(string  $message) : \GuzzleHttp\Psr7\Response

Parses a response message string into a response object.

Parameters

Returns

readline()

readline(\Psr\Http\Message\StreamInterface  $stream, integer  $maxLength = null) : string

Read a line from the stream up to the maximum allowed buffer length

Parameters

Returns

rewind_body()

rewind_body(\Psr\Http\Message\MessageInterface  $message) 

Attempts to rewind a message body and throws an exception on failure.

The body of the message will only be rewound if a call to tell() returns a value other than 0.

Parameters

Throws

\RuntimeException

str()

str(\Psr\Http\Message\MessageInterface  $message) : string

Returns the string representation of an HTTP message.

Parameters

Returns

stream_for()

stream_for(resource|string|null|integer|float|boolean|\Psr\Http\Message\StreamInterface|callable|\Iterator  $resource = '', array  $options = array()) : \Psr\Http\Message\StreamInterface

Create a new stream based on the input type.

Options is an associative array that can contain the following keys:

• metadata: Array of custom metadata.
• size: Size of the stream.

Parameters

Throws

\InvalidArgumentException

if the $resource arg is not valid.

Returns

try_fopen()

try_fopen(string  $filename, string  $mode) : resource

Safely opens a PHP stream resource using a filename.

When fopen fails, PHP normally raises a warning. This function adds an error handler that checks for errors and throws an exception instead.

Parameters

Throws

\RuntimeException

if the file cannot be opened

Returns

uri_for()

uri_for(string|\Psr\Http\Message\UriInterface  $uri) : \Psr\Http\Message\UriInterface

Returns a UriInterface for the given value.

This function accepts a string or \GuzzleHttp\Psr7\Psr\Http\Message\UriInterface and returns a UriInterface for the given value. If the value is already a UriInterface, it is returned as-is.

Parameters

Throws

\InvalidArgumentException

Returns