Class yii\httpclient\JsonFormatter

All Classes | Properties | Methods
Inheritanceyii\httpclient\JsonFormatter » yii\base\BaseObject
Implementsyii\httpclient\FormatterInterface
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-httpclient/blob/master/src/JsonFormatter.php

JsonFormatter formats HTTP message as JSON.

Public Properties

Hide inherited properties

Property Type Description Defined By
$encodeOptions integer The encoding options. yii\httpclient\JsonFormatter

Public Methods

Hide inherited methods

Method Description Defined By
format() Formats given HTTP request message. yii\httpclient\JsonFormatter

Property Details

Hide inherited properties

$encodeOptions public property

The encoding options. For more details please refer to http://www.php.net/manual/en/function.json-encode.php.

public integer $encodeOptions = 0

Method Details

Hide inherited methods

format() public method

Formats given HTTP request message.

public yii\httpclient\Request format ( yii\httpclient\Request $request )
$request yii\httpclient\Request

HTTP request instance.
return yii\httpclient\Request

Formatted request.

 

                public function format(Request $request)
{
    $request->getHeaders()->set('Content-Type', 'application/json; charset=UTF-8');
    if (($data = $request->getData()) !== null) {
        $request->setContent(Json::encode($request->getData(), $this->encodeOptions));
    }
    return $request;
}