Класс 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
Изменить предпочтительное имя класса на реализацию мутабельного Time.

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

__construct()source public

__construct( string|null $name null )

Конструктор

Параметры

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

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

Cake\Database\Type::__construct()

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

marshal()source public

marshal( mixed $value )

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

Параметры

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

Возвращает

Cake\I18n\Time|DateTime

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

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: Экземпляр драйвера для преобразования.

Возвращает

строка

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

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

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

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: Объект, из которого будут извлечены настройки и конфигурация базы данных

Возвращает

смешанный тип

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

Cake\Database\Type::toStatement()

Реализация

Cake\Database\TypeInterface::toStatement()

useImmutable()source public

useImmutable( )

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

Возвращает

$this

END_OF_DOCUMENT_MARKER

useLocaleParser()source public

useLocaleParser( boolean $enable true )

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

Параметры

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

Возвращает

$this

useMutable()source public

useMutable( )

Изменяет предпочтительное имя класса на изменяемую реализацию 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: Значение, которое нужно преобразовать в строку.

Возвращает

boolean

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

$_classNamesource

protected string

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

$_datetimeInstancesource

protected DateTime

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

$_formatsource

protected string

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

'Y-m-d H:i:s'

$_localeFormatsource

protected string|array|integer

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

$_namesource

protected string|null

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

null

$_useLocaleParsersource

protected boolean

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

false

$dateTimeClasssource

public static string

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

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

Устарело

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

'Cake\I18n\Time'

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Database.Type.DateTimeType.html