Class yii\httpclient\UrlEncodedFormatter

Inheritance	yii\httpclient\UrlEncodedFormatter » yii\base\Object
Implements	yii\base\Configurable, yii\httpclient\FormatterInterface
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-httpclient/blob/master/UrlEncodedFormatter.php

UrlEncodedFormatter formats HTTP message as 'application/x-www-form-urlencoded'.

Public Properties

Property	Type	Description	Defined By
$charset	string	The content charset.	yii\httpclient\UrlEncodedFormatter
$encodingType	integer	URL encoding type.	yii\httpclient\UrlEncodedFormatter

Public Methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
format()	Formats given HTTP request message.	yii\httpclient\UrlEncodedFormatter
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\base\Object

Property Details

$charset public property (available since version 2.0.1)

The content charset. If not set, it will use the value of yii\base\Application::$charset.

public string $charset = null

$encodingType public property

URL encoding type. Possible values are:

• PHP_QUERY_RFC1738 - encoding is performed per 'RFC 1738' and the 'application/x-www-form-urlencoded' media type, which implies that spaces are encoded as plus (+) signs. This is most common encoding type used by most web applications.
• PHP_QUERY_RFC3986 - then encoding is performed according to 'RFC 3986', and spaces will be percent encoded (%20). This encoding type is required by OpenID and OAuth protocols.

public integer $encodingType = PHP_QUERY_RFC1738

Method Details