Class yii\httpclient\JsonFormatter

Inheritanceyii\httpclient\JsonFormatter » yii\base\Object
Implementsyii\base\Configurable, yii\httpclient\FormatterInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2-httpclient/blob/master/JsonFormatter.php

JsonFormatter formats HTTP message as JSON.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$encodeOptions integer The encoding options. yii\httpclient\JsonFormatter

Public Methods

Hide inherited methods

MethodDescriptionDefined 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\JsonFormatter
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

$encodeOptions public property

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

Method Details

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.