GqlResponseFormatter ​
- Type
- Class
- Namespace
- craft\web
- Inherits
- craft\web\GqlResponseFormatter » yii\web\JsonResponseFormatter » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable, yii\web\ResponseFormatterInterface
- Since
- 4.17.0
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| contentType | string, null – Custom value of the Content-Type header of the response. |
| encodeOptions | integer – The encoding options passed to yii\helpers\Json::encode(). |
| keepObjectType | boolean – Avoids objects with zero-indexed keys to be encoded as array Json::encode((object)['test']) will be encoded as an object not array. |
| prettyPrint | boolean – Whether to format the output in a readable "pretty" format. |
| useJsonp | boolean – Whether to use JSONP response format. |
contentType ​
Custom value of the Content-Type header of the response. When equals null default content type will be used based on the useJsonp property.
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| format() | Formats the specified response. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| trigger() | Triggers an event. |
Protected Methods ​
| Method | Description |
|---|---|
| formatJson() | Formats response data in JSON format. |
| formatJsonp() | Formats response data in JSONP format. |
Constants ​
| Constant | Description |
|---|---|
CONTENT_TYPE_HAL_JSON | HAL JSON Content Type |
CONTENT_TYPE_JSON | JSONP Content Type |
CONTENT_TYPE_JSONP | JSON Content Type |