JsonParser.php 1.29 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\web;

use yii\base\InvalidParamException;
use yii\helpers\Json;

/**
Carsten Brandt committed
14
 * Parses a raw HTTP request using [[\yii\helpers\Json::decode()]]
15 16 17 18 19 20
 *
 * @author Dan Schmidt <danschmidt5189@gmail.com>
 * @since 2.0
 */
class JsonParser implements RequestParserInterface
{
Daniel Schmidt committed
21 22 23 24 25
	/**
	 * @var boolean whether to return objects in terms of associative arrays.
	 */
	public $asArray = true;
	/**
26
	 * @var boolean whether to throw a [[BadRequestHttpException]] if the body is invalid json
Daniel Schmidt committed
27
	 */
28 29
	public $throwException = true;

30

Daniel Schmidt committed
31
	/**
32 33 34
	 * Parses a HTTP request body.
	 * @param string $rawBody the raw HTTP request body.
	 * @param string $contentType the content type specified for the request body.
Daniel Schmidt committed
35
	 * @return array parameters parsed from the request body
36
	 * @throws BadRequestHttpException if the body contains invalid json and [[throwException]] is `true`.
Daniel Schmidt committed
37
	 */
38
	public function parse($rawBody, $contentType)
Daniel Schmidt committed
39 40
	{
		try {
41
			return Json::decode($rawBody, $this->asArray);
Daniel Schmidt committed
42 43
		} catch (InvalidParamException $e) {
			if ($this->throwException) {
44
				throw new BadRequestHttpException('Invalid JSON data in request body: ' . $e->getMessage(), 0, $e);
Daniel Schmidt committed
45 46 47 48
			}
			return null;
		}
	}
49
}