Класс 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
Формат строки, используемый для разбора DateTime
$_localeFormat protected

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

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

boolean

Следует ли анализировать даты с помощью локально ориентированного анализатора при маршалинге строковых входных данных.
$dateTimeClass public static

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

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

_basicTypes, _builtTypes, _types

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

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

Преобразует строку в объект DateTime после разбора её с помощью локально ориентированного анализатора с указанным форматом.
_setClassName() protected
Установить имя класса, используемого при построении объектов.
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
Изменение предпочтительного имени класса на реализацию мутабельного времени.

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

__construct()source public

__construct( string|null $name null )

Конструктор

Параметры

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

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

Cake\Database\Type::__construct()

_parseValue()source protected

_parseValue( string $value )

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

Параметры

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

Возвращает

Cake\I18n\Time|null

_setClassName()source protected

_setClassName( string $class , string $fallback )

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

Параметры

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

marshal()source public

marshal( mixed $value )

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

Параметры

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

Возвращает

Cake\I18n\Time|DateTime

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

Cake\Database\Type::marshal()

Реализация

Cake\Database\TypeInterface::marshal()

setLocaleFormat()source public

setLocaleFormat( string|array $format )

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

Параметры

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

Возвращает

$this

См. также

\Cake\I18n\Time::parseDateTime()

toDatabase()source public

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

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

Параметры

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

Возвращает

строка

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

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

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

Cake\Database\Type::toPHP()

Реализация

Cake\Database\TypeInterface::toPHP()

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(), использовать локально ориентированный анализатор.

Параметры

boolean $enable необязательно true: Включить или выключить

Возвращает

$this

END_OF_DOCUMENT_MARKER

useMutable()source public

useMutable( )

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

Возвращает

$this

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

_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.

Параметры

строка $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|array|Cake\Database\Type|null $type null , string|null $className null )

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

Параметры

строка|массив|Cake\Database\Type|null $type необязательно null: если строка имя типа для отображения, если массив список массивов для отображения
строка|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'

$_localeFormatsource

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

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

$_namesource

protected строка|null

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

null

$_useLocaleParsersource

protected булево

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

false

$dateTimeClasssource

public static строка

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

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

Устарело

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

'Cake\I18n\Time'

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