Класс 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 )

Конструктор

Параметры

строка|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

_parseValue()source protected

_parseValue( string $value )

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

Параметры

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

Возвращает

Cake\I18n\Time|null

_setClassName()source protected

_setClassName( string $class , string $fallback )

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

Параметры

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

getDateTimeClassName()source public

getDateTimeClassName( )

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

Возвращает

строка

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

Параметры

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

Возвращает

mixed

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

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

useMutable()source public

useMutable( )

Изменить предпочтительное имя класса на mutable Time.

Возвращает

$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

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

$_classNamesource

protected string

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

$_datetimeInstancesource

protected DateTime

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

$_formatsource

protected string|array

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

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

$_localeFormatsource

protected string|array|integer

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

$_namesource

protected string|null

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

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

$_useLocaleParsersource

protected boolean

Указывает, нужно ли анализировать даты с использованием регионального анализатора при маршалинге строковых входных данных.

false

$dateTimeClasssource

public static string

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

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

Устаревшее

3.2.0 Используйте 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.4/class-Cake.Database.Type.DateTimeType.html