<?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.0.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 PDO;
use RuntimeException;
/**
* Float type converter.
*
* Use to convert float/decimal data between PHP and the database types.
*/
class FloatType 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;
}
/**
* The class to use for representing number objects
*
* @var string
*/
public static $numberClass = 'Cake\I18n\Number';
/**
* Whether numbers should be parsed using a locale aware parser
* when marshalling string inputs.
*
* @var bool
*/
protected $_useLocaleParser = false;
/**
* Convert integer data into the database format.
*
* @param string|resource $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return float|null
*/
public function toDatabase($value, Driver $driver)
{
if ($value === null || $value === '') {
return null;
}
return (float)$value;
}
/**
* Convert float values to PHP integers
*
* @param null|string|resource $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return float|null
* @throws \Cake\Core\Exception\Exception
*/
public function toPHP($value, Driver $driver)
{
if ($value === null) {
return null;
}
return (float)$value;
}
/**
* {@inheritDoc}
*
* @return array
*/
public function manyToPHP(array $values, array $fields, Driver $driver)
{
foreach ($fields as $field) {
if (!isset($values[$field])) {
continue;
}
$values[$field] = (float)$values[$field];
}
return $values;
}
/**
* Get the correct PDO binding type for integer 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 PHP floats.
*
* @param mixed $value The value to convert.
* @return float|null Converted value.
*/
public function marshal($value)
{
if ($value === null || $value === '') {
return null;
}
if (is_string($value) && $this->_useLocaleParser) {
return $this->_parseValue($value);
}
if (is_numeric($value)) {
return (float)$value;
}
return null;
}
/**
* Sets whether or not to parse numbers passed to the marshal() function
* by using a locale aware parser.
*
* @param bool $enable Whether or not to enable
* @return $this
*/
public function useLocaleParser($enable = true)
{
if ($enable === false) {
$this->_useLocaleParser = $enable;
return $this;
}
if (static::$numberClass === 'Cake\I18n\Number' ||
is_subclass_of(static::$numberClass, 'Cake\I18n\Number')
) {
$this->_useLocaleParser = $enable;
return $this;
}
throw new RuntimeException(
sprintf('Cannot use locale parsing with the %s class', static::$numberClass)
);
}
/**
* Converts a string into a float point after parsing it using the locale
* aware parser.
*
* @param string $value The value to parse and convert to an float.
* @return float
*/
protected function _parseValue($value)
{
$class = static::$numberClass;
return $class::parseFloat($value);
}
}