Класс DateType

_parseValue()source protected

_parseValue( string $value )

Преобразует строку в объект DateTime после её разбора с использованием локально-ориентированного парсера с указанным форматом.

Параметры

строка $value

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

Возвращает

Cake\I18n\Time|null

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

Cake\Database\Type\DateTimeType::_parseValue()

marshal()source public

marshal( mixed $value )

Преобразование данных запроса в объект datetime.

Параметры

смешанный $value

Данные запроса

Возвращает

DateTimeInterface

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

Cake\Database\Type\DateTimeType::marshal()

useImmutable()source public

useImmutable( )

Изменение предпочтительного имени класса на FrozenDate.

Возвращает

$this

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

Cake\Database\Type\DateTimeType::useImmutable()

useMutable()source public

useMutable( )

Изменение предпочтительного имени класса на изменяемый тип Date.

Возвращает

$this

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

Cake\Database\Type\DateTimeType::useMutable()

__construct()source public

__construct( string|null $name = null )

Конструктор

Параметры

строка|null $name необязательно null

Имя, определяющее этот тип

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

Cake\Database\Type::__construct()

_compare()source protected

_compare( Cake\I18n\Time|DateTime $date , mixed $value )

Параметры

Cake\I18n\Time|DateTime $date

Объект DateTime

смешанный $value

Данные запроса

Возвращает

boolean

_setClassName()source protected

_setClassName( string $class , string $fallback )

Установить имя класса для создания объектов.

Параметры

строка $class

Имя используемого класса.

строка $fallback

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

getDateTimeClassName()source public

getDateTimeClassName( )

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

Возвращает

строка

manyToPHP()source public

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

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

Параметры

массив $values

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

массив $fields

Ключи полей для преобразования

Cake\Database\Driver $driver

Объект, из которого будут извлечены параметры базы данных и конфигурация.

Возвращает

массив

Реализация

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

setLocaleFormat()source public

setLocaleFormat( string|array $format )

Устанавливает строку формата для разбора дат в этом классе. Форматы, которые принимаются, описаны в функции Cake\I18n\Time::parseDateTime().

Параметры

строка|массив $format

Формат, в котором передаются строки.

Возвращает

$this

См.

\Cake\I18n\Time::parseDateTime()

setTimezone()source public

setTimezone( string|DateTimeZone|null $timezone )

Установить часовой пояс базы данных.

Указанный часовой пояс будет установлен для объектов DateTime перед генерацией строки datetime для сохранения в базе данных. Если null преобразование часовых поясов не будет выполнено.

Параметры

строка|DateTimeZone|null $timezone

Часовой пояс базы данных.

Возвращает

$this

toDatabase()source public

toDatabase( string|integer|DateTime|DateTimeImmutable $value , Cake\Database\Driver $driver )

Преобразовать экземпляр DateTime в строки.

Параметры

строка|целое число|DateTime|DateTimeImmutable $value

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

Cake\Database\Driver $driver

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

Возвращает

строка|null

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

Cake\Database\Type::toDatabase()

Реализация

Cake\Database\TypeInterface::toDatabase()

toPHP()source public

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

Преобразовать строки в экземпляры DateTime.

Параметры

строка $value

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

Cake\Database\Driver $driver

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

Возвращает

Cake\I18n\Time|DateTime|null

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

Cake\Database\Type::toPHP()

Реализация

Cake\Database\TypeInterface::toPHP()

toStatement()source public

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

Преобразует заданное значение в эквивалент Statement.

Параметры

mixed $value

Значение, которое необходимо преобразовать в PDO-запрос.

Cake\Database\Driver $driver

Объект, из которого будут извлечены настройки и конфигурация базы данных.

Возвращает

mixed

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

Cake\Database\Type::toStatement()

Реализация

Cake\Database\TypeInterface::toStatement()

useLocaleParser()source public

useLocaleParser( boolean $enable = true )

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

Параметры

boolean $enable необязательно true

Включить или выключить использование локально-зависимого анализатора.

Возвращает

$this

__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 )

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

Параметры

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()

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

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

Параметры

string $name

Идентификатор типа, который вы хотите установить.

Cake\Database\Type $instance

Экземпляр типа, который вы хотите установить.

setMap()source public static

setMap( array $map )

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

Параметры

array $map

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

С версии

3.6.2

strval()source public static deprecated

strval( mixed $value )

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

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

Устарело

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

Параметры

mixed $value

Значение, которое необходимо преобразовать в строку.

Возвращает

string

'Y-m-d'

'Cake\I18n\Date'

true