Class QueryString

Query string object to handle managing query string parameters and aggregating those parameters together as a string.

Guzzle\Common\Collection implements ArrayAccess, IteratorAggregate, Countable, Guzzle\Common\ToArrayInterface

Extended by

Guzzle\Http\QueryString

Namespace: Guzzle\Http
Located at Guzzle/Http/QueryString.php

Methods summary
`public static Guzzle\Http\QueryString`	# `fromString( string $query )` Parse a query string into a QueryString object Parse a query string into a QueryString object Parameters `$query` `string` $query Query string to parse Returns `Guzzle\Http\QueryString`
`public string`	# `__toString( )` Convert the query string parameters to a query string string Convert the query string parameters to a query string string Returns `string`
`public string`	# `getFieldSeparator( )` Get the query string field separator Get the query string field separator Returns `string`
`public string`	# `getValueSeparator( )` Get the query string value separator Get the query string value separator Returns `string`
`public boolean\|string`	# `getUrlEncoding( )` Returns the type of URL encoding used by the query string Returns the type of URL encoding used by the query string One of: false, "RFC 3986", or "application/x-www-form-urlencoded" Returns `boolean\|string`
`public boolean`	# `isUrlEncoding( )` Returns true or false if using URL encoding Returns true or false if using URL encoding Returns `boolean`
`public Guzzle\Http\QueryString`	# `setAggregator( Guzzle\Http\QueryAggregator\QueryAggregatorInterface $aggregator = null )` Provide a function for combining multi-valued query string parameters into a single or multiple fields Provide a function for combining multi-valued query string parameters into a single or multiple fields Parameters `$aggregator` `null\|Guzzle\Http\QueryAggregator\QueryAggregatorInterface` $aggregator Pass in a QueryAggregatorInterface object to handle converting deeply nested query string variables into a flattened array. Pass null to use the default PHP style aggregator. For legacy reasons, this function accepts a callable that must accepts a $key, $value, and query object. Returns `Guzzle\Http\QueryString` See \Guzzle\Http\QueryString::aggregateUsingComma()
`public Guzzle\Http\QueryString`	# `useUrlEncoding( boolean\|string $encode )` Set whether or not field names and values should be rawurlencoded Set whether or not field names and values should be rawurlencoded Parameters `$encode` `boolean\|string` $encode Set to TRUE to use RFC 3986 encoding (rawurlencode), false to disable encoding, or form_urlencoding to use application/x-www-form-urlencoded encoding (urlencode) Returns `Guzzle\Http\QueryString`
`public Guzzle\Http\QueryString`	# `setFieldSeparator( string $separator )` Set the query string separator Set the query string separator Parameters `$separator` `string` $separator The query string separator that will separate fields Returns `Guzzle\Http\QueryString`
`public Guzzle\Http\QueryString`	# `setValueSeparator( string $separator )` Set the query string value separator Set the query string value separator Parameters `$separator` `string` $separator The query string separator that will separate values from fields Returns `Guzzle\Http\QueryString`
`public array`	# `urlEncode( )` Returns an array of url encoded field names and values Returns an array of url encoded field names and values Returns `array`
`public string`	# `encodeValue( string $value )` URL encodes a value based on the url encoding type of the query string object URL encodes a value based on the url encoding type of the query string object Parameters `$value` `string` $value Value to encode Returns `string`
`protected array`	# `prepareData( array $data )` Url encode parameter data and convert nested query strings into a flattened hash. Url encode parameter data and convert nested query strings into a flattened hash. Parameters `$data` `array` $data The data to encode Returns `array` Returns an array of encoded values and keys

Methods inherited from Guzzle\Common\Collection
`__construct(), add(), clear(), count(), filter(), fromConfig(), get(), getAll(), getIterator(), getKeys(), getPath(), hasKey(), hasValue(), inject(), keySearch(), map(), merge(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), overwriteWith(), remove(), replace(), set(), toArray()`

Constants summary
`string`	`RFC_3986`	`'RFC 3986'`	# Used to URL encode with rawurlencode Used to URL encode with rawurlencode
`string`	`FORM_URLENCODED`	`'application/x-www-form-urlencoded'`	# Used to encode with urlencode Used to encode with urlencode
`string`	`BLANK`	`"_guzzle_blank_"`	# Constant used to create blank query string values (e.g. ?foo) Constant used to create blank query string values (e.g. ?foo)

Properties summary
`protected string`	`$fieldSeparator`	`'&'`	# The query string field separator (e.g. '&') The query string field separator (e.g. '&')
`protected string`	`$valueSeparator`	`'='`	# The query string value separator (e.g. '=') The query string value separator (e.g. '=')
`protected boolean`	`$urlEncode`	`'RFC 3986'`	# URL encode fields and values? URL encode fields and values?
`protected Guzzle\Http\QueryAggregator\QueryAggregatorInterface`	`$aggregator`		#
`protected static array`	`$defaultAggregator`	`null`	# Cached PHP aggregator Cached PHP aggregator

Properties inherited from Guzzle\Common\Collection
`$data`