Spec-Zone.ru › CakePHP 3.4

Класс DecimalType

Конвертер десятичных типов.

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

Cake\Database\Type implements Cake\Database\TypeInterface
Extended by Cake\Database\Type\DecimalType implements Cake\Database\TypeInterface
Пространство имён: 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

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

  • 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

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

Возвращает


$this

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

_basicTypeCast()source protected

_basicTypeCast( mixed $value )

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

Устарело

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

Параметры

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

Возвращает

mixed

boolval()source public static

boolval( mixed $value )

Конвертер типов для булевых значений.

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

Устарело

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

Параметры

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

Возвращает

boolean

build()source public static

build( string $name )

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

Параметры

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

Возвращает

Cake\Database\Type

Вызывает исключение

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

buildAll()source public static

buildAll( )

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

Возвращает

array

clear()source public static

clear( )

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

getBaseType()source public

getBaseType( )

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

Возвращает

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

Реализация

Cake\Database\TypeInterface::getBaseType()

getName()source public

getName( )

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

Возвращает

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

Реализация

Cake\Database\TypeInterface::getName()

map()source public static

map( string|array|Cake\Database\Type|null $type null , string|null $className null )

Регистрирует новый идентификатор типа и сопоставляет его с полным именем класса с пространством имён. Если вызвана без аргументов, она вернёт текущий массив сопоставлений типов. Если $className опущена, она вернёт сопоставленный класс для $type.

Параметры

string|array|Cake\Database\Type|null $type необязательный null
если строка - имя типа для сопоставления, если массив - список массивов для сопоставления
string|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
Экземпляр типа, который вы хотите установить.

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–2017 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.4/class-Cake.Database.Type.DecimalType.html

Spec-Zone.ru

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