Browse Source

Added Json and JsonExpression.

tags/2.0.0-beta
Qiang Xue 12 years ago
parent
commit
5fd27b7cbb
  1. 22
      framework/assets/yii.activeForm.js
  2. 18
      framework/helpers/Json.php
  3. 45
      framework/helpers/JsonExpression.php
  4. 107
      framework/helpers/base/Json.php
  5. 60
      tests/unit/framework/helpers/JsonTest.php

22
framework/assets/yii.activeForm.js

@ -23,6 +23,12 @@
}; };
var defaults = { var defaults = {
// the container CSS class representing the corresponding attribute has validation error
errorCssClass: 'error',
// the container CSS class representing the corresponding attribute passes validation
successCssClass: 'success',
// the container CSS class representing the corresponding attribute is being validated
validatingCssClass: 'validating',
// whether it is waiting for ajax submission result // whether it is waiting for ajax submission result
submitting: false submitting: false
}; };
@ -32,21 +38,17 @@
* Initializes the plugin. * Initializes the plugin.
* @param attributes array attribute configurations. Each attribute may contain the following options: * @param attributes array attribute configurations. Each attribute may contain the following options:
* *
* - id: 'ModelClass_attribute', // the unique attribute ID * - name: string, attribute name or expression (e.g. "[0]content" for tabular input)
* - model: 'ModelClass', // the model class name * - container: string, the jQuery selector of the container of the input field
* - name: 'name', // attribute name * - input: string, the jQuery selector of the input field
* - inputID: 'input-tag-id', * - error: string, the jQuery selector of the error tag
* - errorID: 'error-tag-id', * - value: string|array, the value of the input
* - value: undefined, * - status: integer, 0: empty, not entered before, 1: validated, 2: pending validation, 3: validating
* - status: 0, // 0: empty, not entered before, 1: validated, 2: pending validation, 3: validating
* - validationDelay: 200, * - validationDelay: 200,
* - validateOnChange: true, * - validateOnChange: true,
* - validateOnType: false, * - validateOnType: false,
* - hideErrorMessage: false, * - hideErrorMessage: false,
* - inputContainer: undefined, * - inputContainer: undefined,
* - errorCssClass: 'error',
* - successCssClass: 'success',
* - validatingCssClass: 'validating',
* - enableAjaxValidation: true, * - enableAjaxValidation: true,
* - enableClientValidation: true, * - enableClientValidation: true,
* - clientValidation: undefined, // function (value, messages, attribute) | client-side validation * - clientValidation: undefined, // function (value, messages, attribute) | client-side validation

18
framework/helpers/Json.php

@ -0,0 +1,18 @@
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\helpers;
/**
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class Json extends base\Json
{
}

45
framework/helpers/JsonExpression.php

@ -0,0 +1,45 @@
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\helpers;
use yii\base\Object;
/**
* JsonExpression marks a string as a JavaScript expression.
* 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
*/
class JsonExpression extends Object
{
/**
* @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;
}
}

107
framework/helpers/base/Json.php

@ -0,0 +1,107 @@
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\helpers\base;
use yii\base\InvalidParamException;
use yii\helpers\JsonExpression;
/**
* Json is a helper class providing JSON data encoding and decoding.
* It enhances the PHP built-in functions `json_encode()` and `json_decode()`
* by supporting encoding JavaScript expressions and throwing exceptions when decoding fails.
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class Json
{
/**
* Encodes the given value into a JSON string.
* The method enhances `json_encode()` by supporting JavaScript expressions.
* In particular, the method will not encode a JavaScript expression that is
* represented in terms of a [[JsonExpression]] object.
* @param mixed $value the data to be encoded
* @param integer $options the encoding options. For more details please refer to
* [[http://www.php.net/manual/en/function.json-encode.php]]
* @return string the encoding result
*/
public static function encode($value, $options = 0)
{
$expressions = array();
$value = static::processData($value, $expressions);
$json = json_encode($value, $options);
return $expressions === array() ? $json : strtr($json, $expressions);
}
/**
* Decodes the given JSON string into a PHP data structure.
* @param string $json the JSON string to be decoded
* @param boolean $asArray whether to return objects in terms of associative arrays.
* @return mixed the PHP data
* @throws InvalidParamException if there is any decoding error
*/
public static function decode($json, $asArray = true)
{
if (is_array($json)) {
throw new InvalidParamException('Invalid JSON data.');
}
$decode = json_decode((string)$json, $asArray);
switch (json_last_error()) {
case JSON_ERROR_NONE:
break;
case JSON_ERROR_DEPTH:
throw new InvalidParamException('The maximum stack depth has been exceeded.');
case JSON_ERROR_CTRL_CHAR:
throw new InvalidParamException('Control character error, possibly incorrectly encoded.');
case JSON_ERROR_SYNTAX:
throw new InvalidParamException('Syntax error.');
case JSON_ERROR_STATE_MISMATCH:
throw new InvalidParamException('Invalid or malformed JSON.');
case JSON_ERROR_UTF8:
throw new InvalidParamException('Malformed UTF-8 characters, possibly incorrectly encoded.');
default:
throw new InvalidParamException('Unknown JSON decoding error.');
}
return $decode;
}
/**
* Pre-processes the data before sending it to `json_encode()`.
* @param mixed $data the data to be processed
* @param array $expressions collection of JavaScript expressions
* @return mixed the processed data
*/
protected static function processData($data, &$expressions)
{
if (is_array($data)) {
foreach ($data as $key => $value) {
if (is_array($value) || is_object($value)) {
$data[$key] = static::processData($value, $expressions);
}
}
return $data;
} elseif (is_object($data)) {
if ($data instanceof JsonExpression) {
$token = '!{[' . count($expressions) . ']}!';
$expressions['"' . $token . '"'] = $data->expression;
return $token;
}
$result = array();
foreach ($data as $key => $value) {
if (is_array($value) || is_object($value)) {
$result[$key] = static::processData($value, $expressions);
} else {
$result[$key] = $value;
}
}
return $result;
} else {
return $data;
}
}
}

60
tests/unit/framework/helpers/JsonTest.php

@ -0,0 +1,60 @@
<?php
namespace yiiunit\framework\helpers;
use yii\helpers\Json;
use yii\helpers\JsonExpression;
class JsonTest extends \yii\test\TestCase
{
public function testEncode()
{
// basic data encoding
$data = '1';
$this->assertSame('"1"', Json::encode($data));
// simple array encoding
$data = array(1, 2);
$this->assertSame('[1,2]', Json::encode($data));
$data = array('a' => 1, 'b' => 2);
$this->assertSame('{"a":1,"b":2}', Json::encode($data));
// simple object encoding
$data = new \stdClass();
$data->a = 1; $data->b = 2;
$this->assertSame('{"a":1,"b":2}', Json::encode($data));
// expression encoding
$expression = 'function () {}';
$data = new JsonExpression($expression);
$this->assertSame($expression, Json::encode($data));
// complex data
$expression1 = 'function (a) {}';
$expression2 = 'function (b) {}';
$data = array(
'a' => array(
1, new JsonExpression($expression1)
),
'b' => new JsonExpression($expression2),
);
$this->assertSame("{\"a\":[1,$expression1],\"b\":$expression2}", Json::encode($data));
}
public function testDecode()
{
// basic data decoding
$json = '"1"';
$this->assertSame('1', Json::decode($json));
// array decoding
$json = '{"a":1,"b":2}';
$this->assertSame(array('a' => 1, 'b' => 2), Json::decode($json));
// exception
$json = '{"a":1,"b":2';
$this->setExpectedException('yii\base\InvalidParamException');
Json::decode($json);
}
}
Loading…
Cancel
Save