Класс DecimalType
Конвертер типа Decimal.
Используется для преобразования десятичных данных между PHP и типами баз данных.
- Cake\Database\Type implements Cake\Database\TypeInterface
-
Cake\Database\Type\DecimalType implements Cake\Database\TypeInterface, Cake\Database\Type\BatchCastingInterface
Краткое описание свойств
-
$_nameprotectedИмя идентификатора для этого типа.string|null -
$_useLocaleParserprotectedbooleanУказывает, должны ли числа анализироваться с учётом локали при преобразовании строковых входных данных.
- Класс для представления числовых объектов
string
Наследованные свойства
Краткое описание методов
- __construct() publicКонструктор.
- _parseValue() protected
Преобразует строку в число с плавающей точкой после анализа с учётом локали.
- manyToPHP() public
Возвращает массив значений, преобразованных в представление этого типа в PHP.
- marshal() publicПреобразует данные запроса в числа с плавающей точкой PHP.
- toDatabase() publicПреобразование целочисленных данных в формат базы данных.
- toPHP() publicПреобразование значений с плавающей точкой в числа с плавающей точкой PHP.
- toStatement() publicПолучение правильного типа привязки PDO для целочисленных данных.
- useLocaleParser() public
Устанавливает, нужно ли анализировать числа, переданные в функцию marshal(), с учётом локали.
Подробное описание методов
__construct()source public
__construct( string|null $name = null )
Конструктор.
(Этот метод объявлен здесь повторно, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)
Параметры
- string|null
$nameoptional null - Имя, идентифицирующее этот тип
Переопределяет
Cake\Database\Type::__construct() _parseValue()source protected
_parseValue( string $value )
Преобразует строку в число с плавающей точкой после анализа с учётом локали.
Параметры
- string
$value - Значение для анализа и преобразования в число с плавающей точкой.
Возвращает
floatmanyToPHP()source public
manyToPHP( array $values , array $fields , Cake\Database\Driver $driver )
Возвращает массив значений, преобразованных в представление этого типа в PHP.
Параметры
- array
$values - Исходный массив значений, содержащий поля для преобразования
- array
$fields - Ключи полей для преобразования
-
Cake\Database\Driver$driver - Объект, из которого извлекаются настройки и конфигурация базы данных.
Возвращает
arrayРеализация
Cake\Database\Type\BatchCastingInterface::manyToPHP() marshal()source public
marshal( mixed $value )
Преобразует данные запроса в числа с плавающей точкой PHP.
Параметры
- mixed
$value - Значение для преобразования.
Возвращает
mixedПреобразованное значение.
Переопределяет
Cake\Database\Type::marshal() Реализация
Cake\Database\TypeInterface::marshal() toDatabase()source public
toDatabase( string|integer|float $value , Cake\Database\Driver $driver )
Преобразование целочисленных данных в формат базы данных.
Параметры
- string|integer|float
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
string|nullИсключения
InvalidArgumentExceptionПереопределяет
Cake\Database\Type::toDatabase() Реализация
Cake\Database\TypeInterface::toDatabase() toPHP()source public
toPHP( null|string|resource $value , Cake\Database\Driver $driver )
Преобразование значений с плавающей точкой в числа с плавающей точкой PHP
Параметры
- null|string|resource
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
float|nullИсключения
Cake\Core\Exception\ExceptionПереопределяет
Cake\Database\Type::toPHP() Реализация
Cake\Database\TypeInterface::toPHP() toStatement()source public
toStatement( mixed $value , Cake\Database\Driver $driver )
Получение правильного типа привязки PDO для целочисленных данных.
Параметры
- mixed
$value - Связываемое значение.
-
Cake\Database\Driver$driver - Драйвер.
Возвращает
integerПереопределяет
Cake\Database\Type::toStatement() Реализация
Cake\Database\TypeInterface::toStatement() useLocaleParser()source public
useLocaleParser( boolean $enable = true )
Устанавливает, нужно ли анализировать числа, переданные в функцию marshal(), с учётом локали.
Параметры
- boolean
$enableoptional true - Включить или нет
Возвращает
$this
Наследованные методы из Cake\Database\Type
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
array_basicTypeCast()source protected deprecated
_basicTypeCast( mixed $value )
Проверяет, является ли этот тип базовый, и может ли он быть преобразован с помощью обратного вызова Если это так, возвращает преобразованное значение
Устарело
3.1 Все типы теперь должны быть отдельными классамиПараметры
- mixed
$value - Значение, подлежащее преобразованию в PHP-эквивалент
Возвращает
mixedboolval()source public static deprecated
boolval( mixed $value )
Конвертер типа для логических значений.
Преобразует строки true/false в булевы.
Устарело
3.1.8 Этот метод больше не используется.Параметры
- mixed
$value - Значение для преобразования в логическое.
Возвращает
booleanbuild()source public static
build( string $name )
Возвращает объект Type, способный преобразовывать тип, определённый по имени.
Параметры
- строка
$name - идентификатор типа
Возвращает
Cake\Database\TypeИсключения
InvalidArgumentExceptionЕсли идентификатор типа неизвестен
buildAll()source public static
buildAll( )
Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени.
Возвращает
массивclear()source public static
clear( )
Очищает все созданные экземпляры и сопоставленные типы классов, полезно для тестирования
getBaseType()source public
getBaseType( )
Возвращает имя базового типа, от которого наследуется этот класс.
Возвращает
строкаИмя базового типа, от которого наследуется этот класс.
Реализация
Cake\Database\TypeInterface::getBaseType() getMap()source public static
getMap( string|null $type = null )
Получить имя сопоставленного класса или экземпляр для типа(ов).
Параметры
- строка|null
$typeнеобязательно null - Имя типа, для которого требуется сопоставленный класс, или null для получения массива сопоставлений.
Возвращает
массив|строка|Cake\Database\TypeInterface|nullНастроенное имя класса или экземпляр для данного $type или массив сопоставлений.
С тех пор
3.6.2getName()source public
getName( )
Возвращает имя идентификатора типа для этого объекта.
Возвращает
строкаИмя идентификатора типа для этого объекта.
Реализация
Cake\Database\TypeInterface::getName() map()source public static
map( string|string[]|Cake\Database\Type[]|null $type = null , string|Cake\Database\Type|null $className = null )
Регистрирует новый идентификатор типа и сопоставляет его с полным именем класса, Если вызывается без аргументов, она вернёт текущий массив сопоставлений типов Если $className опущена, она вернёт сопоставленный класс для $type
Устаревшая функция 3.6.2: - Использование $type как string[]|\Cake\Database\Type[] устарело. Используйте Type::setMap() со string[] вместо этого. - Передача $className как \Cake\Database\Type instance устарела, используйте только имя класса в виде строки. - Использование этого метода в качестве getter устарело. Используйте Type::getMap() вместо этого.
Параметры
- строка|массив строк|
Cake\Database\Type[]|null$typeнеобязательно null - Если строка - имя типа для сопоставления, если массив - список массивов для сопоставления
- строка|
Cake\Database\Type|null$classNameнеобязательно null - Имя класса или экземпляр объекта, который нужно зарегистрировать.
Возвращает
массив|строка|nullЕсли $type равно null, то массив с текущим сопоставлением, если $className равно null, то строка с настроенным именем класса для данного $type, иначе null
newId()source public
newId( )
Генерирует новое значение первичного ключа для заданного типа.
Возвращает
смешанныйНовое значение первичного ключа.
Реализация
Cake\Database\TypeInterface::newId() set()source public static
set( string $name , Cake\Database\Type $instance )
Возвращает объект Type, способный преобразовывать тип, определённый по $name
Параметры
- строка
$name - Идентификатор типа, который вы хотите установить.
-
Cake\Database\Type$instance - Экземпляр типа, который вы хотите установить.
setMap()source public static
setMap( array $map )
Устанавливает сопоставление типа с именем класса.
Параметры
- массив
$map - Список типов, которые нужно сопоставить.
С тех пор
3.6.2strval()source public static deprecated
strval( mixed $value )
Преобразователь типов для строковых значений.
Преобразует значения в строки
Устаревшая функция
3.1.8 Этот метод теперь не используется.Параметры
- смешанный
$value - Значение, которое нужно преобразовать в строку.
Возвращает
строкаПодробное описание свойств
$_namesource
protected строка|null
Имя идентификатора этого типа.
(Это свойство снова объявлено здесь, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)
$_useLocaleParsersource
protected boolean
Указывает, следует ли использовать локально-ориентированный парсер для преобразования чисел при преобразовании строковых входных данных.
false
$numberClasssource
public static строка
Класс, используемый для представления числовых объектов
'Cake\I18n\Number'
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Database.Type.DecimalType.html