Permalink
Fetching contributors…
Cannot retrieve contributors at this time
123 lines (111 sloc) 3.2 KB
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.3.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Database\Type;
use Cake\Database\Driver;
use Cake\Database\Type;
use Cake\Database\TypeInterface;
use Cake\Database\Type\BatchCastingInterface;
use InvalidArgumentException;
use PDO;
/**
* Json type converter.
*
* Use to convert json data between PHP and the database types.
*/
class JsonType extends Type implements TypeInterface, BatchCastingInterface
{
/**
* Identifier name for this type.
*
* (This property is declared here again so that the inheritance from
* Cake\Database\Type can be removed in the future.)
*
* @var string|null
*/
protected $_name;
/**
* Constructor.
*
* (This method is declared here again so that the inheritance from
* Cake\Database\Type can be removed in the future.)
*
* @param string|null $name The name identifying this type
*/
public function __construct($name = null)
{
$this->_name = $name;
}
/**
* Convert a value data into a JSON string
*
* @param mixed $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return string|null
*/
public function toDatabase($value, Driver $driver)
{
if (is_resource($value)) {
throw new InvalidArgumentException('Cannot convert a resource value to JSON');
}
return json_encode($value);
}
/**
* Convert string values to PHP arrays.
*
* @param mixed $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return string|null|array
*/
public function toPHP($value, Driver $driver)
{
return json_decode($value, true);
}
/**
* {@inheritDoc}
*
* @return array
*/
public function manyToPHP(array $values, array $fields, Driver $driver)
{
foreach ($fields as $field) {
if (!isset($values[$field])) {
continue;
}
$values[$field] = json_decode($values[$field], true);
}
return $values;
}
/**
* Get the correct PDO binding type for string data.
*
* @param mixed $value The value being bound.
* @param \Cake\Database\Driver $driver The driver.
* @return int
*/
public function toStatement($value, Driver $driver)
{
return PDO::PARAM_STR;
}
/**
* Marshalls request data into a JSON compatible structure.
*
* @param mixed $value The value to convert.
* @return mixed Converted value.
*/
public function marshal($value)
{
return $value;
}
}