Json

Type
Class
Namespace
craft\helpers
Inherits
craft\helpers\Json » yii\helpers\Json (opens new window) » yii\helpers\BaseJson (opens new window)
Since
3.0.0

Class Json

View source (opens new window)

# Public Properties

# Public Methods

Method Description
decode() (opens new window) Decodes the given JSON string into a PHP data structure.
decodeIfJson() Decodes the given JSON string into a PHP data structure, only if the string is valid JSON.
encode() (opens new window) Encodes the given value into a JSON string.
errorSummary() (opens new window) Generates a summary of the validation errors.
htmlEncode() (opens new window) Encodes the given value into a JSON string HTML-escaping entities so it is safe to be embedded in HTML code.
isJsonObject() Returns whether a string value looks like a JSON object or array.

# decodeIfJson()

Decodes the given JSON string into a PHP data structure, only if the string is valid JSON.

View source (opens new window)

Arguments

  • $str (mixed) – The string to be decoded, if it's valid JSON.
  • $asArray (boolean (opens new window)) – Whether to return objects in terms of associative arrays.

Returns

mixed – The PHP data, or the given string if it wasn’t valid JSON.

# isJsonObject()

Since
3.5.0

Returns whether a string value looks like a JSON object or array.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# Protected Methods

Method Description
handleJsonError() (opens new window) Handles encode() (opens new window) and decode() (opens new window) errors by throwing exceptions with the respective error message.
processData() (opens new window) Pre-processes the data before sending it to json_encode().