JsExpression

API reference › yii › web › JsExpression

class	`yii\web\JsExpression`
Extends	`yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/web/JsExpression.php`

JsExpression marks a string as a JavaScript expression.

When using Json::encode() or Json::htmlEncode() to encode a value, JsExpression objects will be specially handled and encoded as a JavaScript expression instead of a string.

Properties

Property	Type	Description	Defined by
`$expression`	`string`	The JavaScript expression represented by this object Default: `null`.	`JsExpression`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`JsExpression`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__toString()`	The PHP magic function converting an object into a string.	`JsExpression`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`

Method details

__construct()

public function __construct(string $expression, array $config = [])

Constructor.

Parameters

Parameter	Type	Description
`$expression`	`string`	The JavaScript expression represented by this object
`$config`	`array`	Additional configurations for this object

__toString()

public function __toString(): string

The PHP magic function converting an object into a string.

Returns

string: The JavaScript expression.