Класс DateTimeType

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

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

Cake\Database\Type implements Cake\Database\TypeInterface

Cake\Database\Type\DateTimeType implements Cake\Database\TypeInterface

Прямые подклассы

Пространство имён: Cake\Database\Type
Расположение: Database/Type/DateTimeType.php

Резюме свойств

$_className protected

string
Имя класса, используемого при создании объектов.
$_datetimeInstance protected

DateTime

Экземпляр настроенного класса dateTimeClass, используемый для быстрого создания новых экземпляров без вызова конструктора.
$_format protected

string|array
Формат строки, используемый для разбора DateTime.
$_localeFormat protected

string|array|integer
Формат даты, используемый для разбора входящих дат для маршаллирования.
$_name protected

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

boolean

Необходимо ли использовать локально-зависимый разбор дат при маршаллировании входных данных в виде строк.
$dateTimeClass public static

string
Класс, используемый для представления объектов даты

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

_basicTypes, _builtTypes, _types

Резюме методов

__construct() public
Конструктор
_compare() protected
_parseValue() protected

Преобразует строку в объект DateTime после её разбора с помощью локально-зависимого разбора с указанным форматом.
_setClassName() protected
Устанавливает имя класса для создания объектов.
getDateTimeClassName() public
Получение имени класса, используемого для создания объектов.
marshal() public
Преобразование данных запроса в объект datetime.
setLocaleFormat() public

Устанавливает строку формата, используемую для разбора дат в этом классе. Форматы, которые принимаются, документированы в функции Cake\I18n\Time::parseDateTime().
toDatabase() public
Преобразование экземпляра DateTime в строки.
toPHP() public
Преобразование строк в экземпляры DateTime.
toStatement() public
Преобразование данного значения в эквивалент Statement.
useImmutable() public
Изменение предпочтительного имени класса на реализацию FrozenTime.
useLocaleParser() public

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

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

__construct()source public

__construct( string|null $name null )

Конструктор

Параметры

string|null $name необязательно null: Имя, идентифицирующее этот тип

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

Cake\Database\Type::__construct()

_compare()source protected

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

Параметры

Cake\I18n\Time|DateTime $date: Объект DateTime
mixed $value: Данные запроса

Возвращает

boolean

_parseValue()source protected

_parseValue( string $value )

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

Параметры

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

Возвращает

Cake\I18n\Time|null

_setClassName()source protected

_setClassName( string $class , string $fallback )

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

Параметры

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

getDateTimeClassName()source public

getDateTimeClassName( )

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

Возвращает

string

marshal()source public

marshal( mixed $value )

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

Параметры

mixed $value: Данные запроса

Возвращает

DateTimeInterface

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

Cake\Database\Type::marshal()

Реализация

Cake\Database\TypeInterface::marshal()

setLocaleFormat()source public

setLocaleFormat( string|array $format )

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

Параметры

string|array $format: Формат, в котором передаются строки.

Возвращает

$this

См. также

\Cake\I18n\Time::parseDateTime()

toDatabase()source public

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

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

Параметры

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

Возвращает

string|null

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

Cake\Database\Type::toDatabase()

Реализация

Cake\Database\TypeInterface::toDatabase()

toPHP()source public

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

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

Параметры

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

Возвращает

Cake\I18n\Time|DateTime|null

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

Cake\Database\Type::toPHP()

Реализация

Cake\Database\TypeInterface::toPHP()

END_OF_DOCUMENT_MARKER

toStatement()source public

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

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

Параметры

смешанное $value: Значение, которое нужно преобразовать в оператор PDO.
Cake\Database\Driver $driver: Объект, из которого будут извлечены настройки и конфигурация базы данных.

Возвращает

смешанное

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

Cake\Database\Type::toStatement()

Реализация

Cake\Database\TypeInterface::toStatement()

useImmutable()source public

useImmutable( )

Изменяет предпочтительное имя класса на реализацию FrozenTime.

Возвращает

$this

useLocaleParser()source public

useLocaleParser( boolean $enable true )

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

Параметры

булево $enable необязательно true: Включить или отключить функцию.

Возвращает

$this

useMutable()source public

useMutable( )

Изменяет предпочтительное имя класса на реализацию мутабельного типа Time.

Возвращает

$this

Методы, унаследованные от Cake\Database\Type

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

_basicTypeCast()source protected

_basicTypeCast( mixed $value )

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

Устарело

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

Параметры

смешанное $value: Значение, которое нужно преобразовать в PHP эквивалент.

Возвращает

смешанное

boolval()source public static

boolval( mixed $value )

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

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

Устарело

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

Параметры

смешанное $value: Значение, которое нужно преобразовать в булево.

Возвращает

булево

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

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

Устарело: Использование $type как \Cake\Database\Type[] устарело. Пожалуйста, всегда используйте string[] если передаете массив в качестве первого аргумента.

Параметры

строка|массив строк|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: Экземпляр типа, который вы хотите установить.

strval()source public static

strval( mixed $value )

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

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

Устарело

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

Параметры

смешанное $value: Значение, которое нужно преобразовать в строку.

Возвращает

строка

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

$_classNamesource

protected строка

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

$_datetimeInstancesource

protected DateTime

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

$_formatsource

protected строка|массив

Строчный формат, используемый для парсинга DateTime.

[
    'Y-m-d H:i:s',
    'Y-m-d\TH:i:sP',
]

$_localeFormatsource

protected строка|массив|целое число

Формат даты, используемый для анализа входящих дат для маршалинга.

$_namesource

protected строка|null

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

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

$_useLocaleParsersource

protected логическое значение

Нужно ли анализировать даты с использованием локально-зависимого анализатора при преобразовании строковых входных данных.

false

$dateTimeClasssource

public static строка

Класс, используемый для представления объектов даты

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

Устаревшее

3.2.0 Используйте DateTimeType::useMutable() или DateTimeType::useImmutable() вместо этого.

'Cake\I18n\Time'

© 2005–2018 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.5/class-Cake.Database.Type.DateTimeType.html