Spec-Zone.ru › CakePHP 4.2

Класс DecimalType

Конвертер типа decimal.

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

Пространство имён: Cake\Database\Type

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

  • $_name protected
    string|null

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

  • $_useLocaleParser protected
    bool

    Нужно ли использовать локально-зависимый парсер для разбора чисел при преобразовании строковых входных данных?

  • $numberClass public static
    string

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

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

  • __construct() public

    Конструктор

  • _parseValue() protected

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

  • getBaseType() public

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

  • getName() public

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

  • manyToPHP() public

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

  • marshal() public

    Массирует данные запроса в десятичные строки.

  • newId() public

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

  • toDatabase() public

    Преобразует десятичные строки в формат базы данных.

  • toPHP() public

    Преобразует заданное значение из типа базы данных в эквивалентное ему значение PHP.

  • toStatement() public

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

  • useLocaleParser() public

    Устанавливает, нужно ли использовать локализованный анализатор для парсинга чисел, переданных в функцию marshal().

Подробное описание методов

__construct() public

__construct(string|null $name = null)

Конструктор

Параметры

string|null $name необязательно

Имя, идентифицирующее этот тип

_parseValue() protected

_parseValue(string $value): string

Преобразует строку с локальным форматом в десятичную строку после её разбора с помощью локально-зависимого анализатора.

Параметры

string $value

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

Возвращает

string

getBaseType() public

getBaseType(): string|null

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

Это полезно при расширении базового типа для добавления дополнительной функциональности, но при этом вы хотите, чтобы остальная часть фреймворка использовала те же предположения о базовом типе, от которого он наследуется.

Возвращает

string|null

getName() public

getName(): string|null

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

Возвращает

string|null

manyToPHP() public

manyToPHP(array $values, string[] $fields, Cake\Database\DriverInterface $driver): array

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

Параметры

array $values
string[] $fields
Cake\Database\DriverInterface $driver

Возвращает

array

marshal() public

marshal(mixed $value): string|null

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

Наиболее полезно для преобразования данных запроса в объекты PHP, которые имеют смысл для остальных слоев ORM/базы данных.

Параметры

mixed $value

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

Возвращает

string|null

newId() public

newId(): mixed

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

Этот метод может быть использован типами для создания новых значений первичного ключа при вставке сущностей.

Возвращает

mixed

toDatabase() public

toDatabase(mixed $value, Cake\Database\DriverInterface $driver): string|float|int|null

Преобразует десятичные строки в формат базы данных.

Параметры

mixed $value

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

Cake\Database\DriverInterface $driver

Экземпляр драйвера для преобразования.

Возвращает

string|float|int|null

Исключение

InvalidArgumentException

toPHP() public

toPHP(mixed $value, Cake\Database\DriverInterface $driver): string|null

Преобразует значение из типа базы данных в эквивалент PHP.

Параметры

mixed $value

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

Cake\Database\DriverInterface $driver

Экземпляр драйвера для преобразования.

Возвращает

string|null

toStatement() public

toStatement(mixed $value, Cake\Database\DriverInterface $driver): int

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

Параметры

mixed $value

Связываемое значение.

Cake\Database\DriverInterface $driver

Драйвер.

Возвращает

int

useLocaleParser() public

useLocaleParser(bool $enable = true): $this

Устанавливает, нужно ли анализировать числа, переданные в функцию marshal() с помощью локально-зависимого анализатора.

Параметры

bool $enable optional

Включать или нет

Возвращает

$this

Исключение

RuntimeException

Подробное описание свойств

$_name protected

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

Тип

string|null

$_useLocaleParser protected

Определяет, должны ли числа анализироваться с помощью локально-зависимого анализатора при маршализации строковых входных данных.

Тип

bool

$numberClass public static

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

Тип

string

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

Spec-Zone.ru

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