Skip to content

Latest commit

 

History

History
80 lines (38 loc) · 1.5 KB

Query.md

File metadata and controls

80 lines (38 loc) · 1.5 KB

Query

  • Full name: \GuzzleHttp\Psr7\Query
  • This class is marked as final and can't be subclassed
  • This class is a Final class

Methods

parse

Parse a query string into an associative array.

public static parse(string $str, int|bool $urlEncoding = true): 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']).

  • This method is static.

Parameters:

Parameter Type Description
$str string Query string to parse
$urlEncoding int|bool How the query string is encoded

build

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

public static build(array $params, int|false $encoding = PHP_QUERY_RFC3986): string

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

  • This method is static.

Parameters:

Parameter Type Description
$params array Query string parameters.
$encoding int|false Set to false to not encode, PHP_QUERY_RFC3986
to encode using RFC3986, or PHP_QUERY_RFC1738
to encode using RFC1738.