JsExpression.php 1.09 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

Qiang Xue committed
8
namespace yii\web;
9 10 11 12

use yii\base\Object;

/**
13
 * JsExpression marks a string as a JavaScript expression.
14 15 16 17 18
 * When using [[Json::encode()]] to encode a value, JsonExpression objects
 * will be specially handled and encoded as a JavaScript expression instead of a string.
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
19
class JsExpression extends Object
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
{
	/**
	 * @var string the JavaScript expression represented by this object
	 */
	public $expression;

	/**
	 * Constructor.
	 * @param string $expression the JavaScript expression represented by this object
	 * @param array $config additional configurations for this object
	 */
	public function __construct($expression, $config = array())
	{
		$this->expression = $expression;
		parent::__construct($config);
	}

	/**
	 * The PHP magic function converting an object into a string.
	 * @return string the JavaScript expression.
	 */
	public function __toString()
	{
		return $this->expression;
	}
Zander Baldwin committed
45
}