Spec-Zone.ru › CakePHP 3.8

Класс DecimalType

Конвертер десятичного типа.

Используется для преобразования десятичных данных между PHP и типами баз данных.

Cake\Database\Type реализует Cake\Database\TypeInterface
Расширен Cake\Database\Type\DecimalType реализует Cake\Database\TypeInterface, Cake\Database\Type\BatchCastingInterface
Пространство имён: Cake\Database\Type
Расположение: Database/Type/DecimalType.php

Краткое описание свойств

  • $_name protected
    string|null
    Имя идентификатора для этого типа.
  • $_useLocaleParser protected
    boolean

    Определяет, следует ли анализировать числа с учётом локали при преобразовании строковых входных данных.

  • $numberClass public static
    string
    Класс для представления числовых объектов

Унаследованные свойства

  • _basicTypes, _builtTypes, _types

Краткое описание методов

  • __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 $name необязательно null
Имя, идентифицирующее этот тип

Переопределяет

Cake\Database\Type::__construct()

_parseValue()source protected

_parseValue( string $value )

Преобразует строку в число с плавающей точкой после её разбора с учётом локали.

Параметры

string $value
Значение для разбора и преобразования в число с плавающей точкой.

Возвращает

float

manyToPHP()source public

manyToPHP( array $values , array $fields , Cake\Database\Driver $driver )

Возвращает массив значений, преобразованных в представление этого типа в PHP.

Параметры

array $values
Исходный массив значений, содержащий поля, которые нужно преобразовать.
array $fields
Ключи полей для преобразования.
Cake\Database\Driver $driver
Объект, из которого будут извлечены настройки и конфигурация базы данных.

Возвращает

float[]

Реализация

Cake\Database\Type\BatchCastingInterface::manyToPHP()

marshal()source public

marshal( mixed $value )

Преобразует данные запроса в числа с плавающей точкой PHP.

Параметры

mixed $value
Значение для преобразования.

Возвращает

float|string|null
Преобразованное значение.

Переопределяет

Cake\Database\Type::marshal()

Реализация

Cake\Database\TypeInterface::marshal()

toDatabase()source public

toDatabase( mixed $value , Cake\Database\Driver $driver )

Преобразовать целочисленные данные в формат базы данных.

Параметры

mixed $value
Значение для преобразования.
Cake\Database\Driver $driver
Экземпляр драйвера для преобразования.

Возвращает

string|null

Исключения

InvalidArgumentException

Переопределяет

Cake\Database\Type::toDatabase()

Реализация

Cake\Database\TypeInterface::toDatabase()

toPHP()source public

toPHP( mixed $value , Cake\Database\Driver $driver )

Преобразовать значения с плавающей точкой в числа с плавающей точкой PHP.

Параметры

mixed $value
Значение для преобразования.
Cake\Database\Driver $driver
Экземпляр драйвера для преобразования.

Возвращает

float|null

Переопределяет

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 $enable необязательно true
Включить или нет

Возвращает


$this

Исключения

RuntimeException

Наследованные методы из Cake\Database\Type

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array

_basicTypeCast()source protected deprecated

_basicTypeCast( mixed $value )

Проверяет, является ли этот тип базовым и может ли он быть преобразован с помощью обратного вызова Если это так, возвращает преобразованное значение

Устарело

3.1 Все типы теперь должны быть отдельными классами

Параметры

mixed $value
Значение, подлежащее преобразованию в эквивалент PHP

Возвращает

mixed

boolval()source public static deprecated

boolval( mixed $value )

Конвертер типов для логических значений.

Преобразует строки true/false в логические значения.

Устарело

3.1.8 Этот метод больше не используется.

Параметры

mixed $value
Значение для преобразования в логическое.

Возвращает

boolean

build()source public static

build( string $name )

Возвращает объект Type, способный преобразовывать тип, идентифицированный по имени.

Параметры

string $name
Идентификатор типа

Возвращает

Cake\Database\Type

Исключения

InvalidArgumentException
Если идентификатор типа неизвестен
END_OF_DOCUMENT_MARKER

buildAll()source public static

buildAll( )

Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени.

Возвращает

array

clear()source public static

clear( )

Очищает все созданные экземпляры и сопоставленные типы классов, полезно для тестирования

getBaseType()source public

getBaseType( )

Возвращает имя базового типа, от которого наследуется этот класс.

Возвращает

string
Имя базового типа, от которого наследуется этот класс.

Реализация

Cake\Database\TypeInterface::getBaseType()

getMap()source public static

getMap( string|null $type = null )

Получить имя или экземпляр сопоставленного класса для типа(ов).

Параметры

string|null $type необязательно null
Имя типа для получения сопоставленного класса или null для получения массива соответствий.

Возвращает

array|string|Cake\Database\TypeInterface|null
Настроенное имя класса или экземпляр для заданного $type или массив соответствий.

С

3.6.2

getName()source public

getName( )

Возвращает имя идентификатора типа для этого объекта.

Возвращает

string
Имя идентификатора типа для этого объекта.

Реализация

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 экземпляра устарело, используйте только строку имени класса. - Использование этого метода в качестве геттера устарело. Используйте Type::getMap() вместо.

Параметры

string|string[]|Cake\Database\Type[]|null $type необязательно null
Если строка имя типа для сопоставления, если массив списка массивов для сопоставления
string|Cake\Database\Type|null $className необязательно null
Имя класса или экземпляр объекта для регистрации.

Возвращает

array|string|null

Если $type равен null, то массив с текущим соответствием, если $className равен null, то строка настроенного имени класса для данного $type, иначе null


newId()source public

newId( )

Генерирует новое значение первичного ключа для заданного типа.

Возвращает

mixed
Новое значение первичного ключа.

Реализация

Cake\Database\TypeInterface::newId()

set()source public static

set( string $name , Cake\Database\Type $instance )

Возвращает объект Type, способный преобразовать тип, идентифицируемый $name

Параметры

string $name
Идентификатор типа, который вы хотите установить.
Cake\Database\Type $instance
Экземпляр типа, который вы хотите установить.

setMap()source public static

setMap( array $map )

Устанавливает сопоставление типа с именем класса.

Параметры

array $map
Список типов для сопоставления.

С

3.6.2

strval()source public static устаревший

strval( mixed $value )

Преобразователь типа для строковых значений.

Преобразует значения в строки

Устаревший

3.1.8 Этот метод больше не используется.

Параметры

mixed $value
Значение для преобразования в строку.

Возвращает

string

Подробности свойств

$_namesource

protected string|null

Имя идентификатора для этого типа.

(Это свойство объявлено здесь снова, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)

$_useLocaleParsersource

protected boolean

Указывает, должны ли числа парситься с учётом локали при преобразовании строковых входных данных.

false

$numberClasssource

public static string

Класс для представления числовых объектов

'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.8/class-Cake.Database.Type.DecimalType.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API