Класс DateType
Конвертер типа даты и времени.
Используется для преобразования экземпляров DateTime в строки и обратно.
- Cake\Database\Type implements Cake\Database\TypeInterface
-
Cake\Database\Type\DateTimeType implements Cake\Database\TypeInterface
-
Cake\Database\Type\DateType
Краткое описание свойств
-
$_formatprotectedФормат даты для объекта DateTimestring|array - Класс для представления объектов даты
string
Унаследованные свойства
-
_className,_datetimeInstance,_localeFormat,_name,_useLocaleParser_basicTypes,_builtTypes,_types
Краткое описание методов
- _parseValue() protected
Преобразует строку в объект DateTime после её разбора с использованием локализованного парсера со указанным форматом.
- marshal() publicПреобразовать данные запроса в объект datetime.
- toPHP() publicПреобразовать строки в объекты Date.
- useImmutable() publicИзменить предпочтительное имя класса на реализацию FrozenDate.
- useMutable() publicИзменить предпочтительное имя класса на реализацию изменяемого объекта Date.
Подробное описание методов
_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() toPHP()source public
toPHP( string $value , Cake\Database\Driver $driver )
Преобразовать строки в объекты Date.
Параметры
- строка
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
Cake\I18n\Date|DateTimeПереопределяет
Cake\Database\Type\DateTimeType::toPHP() useImmutable()source public
useImmutable( )
Изменить предпочтительное имя класса на реализацию FrozenDate.
Возвращает
$this
Переопределяет
Cake\Database\Type\DateTimeType::useImmutable() useMutable()source public
useMutable( )
Изменить предпочтительное имя класса на реализацию изменяемого объекта Date.
Возвращает
$this
Переопределяет
Cake\Database\Type\DateTimeType::useMutable() Методы унаследованные от Cake\Database\Type\DateTimeType
__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( )
Получить имя класса, используемого при создании объектов.
Возвращает
строка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 - Экземпляр драйвера для преобразования.
Возвращает
строка|nullПереопределяет
Cake\Database\Type::toDatabase() Реализация
Cake\Database\TypeInterface::toDatabase() 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() useLocaleParser()source public
useLocaleParser( boolean $enable true )
Устанавливает, использовать или нет локализованный парсер дат при передаче в функцию marshal().
Параметры
- boolean
$enableнеобязательно true - Включить или нет
Возвращает
$this
Методы унаследованные от Cake\Database\Type
__debugInfo()source public
__debugInfo( )
Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.
Возвращает
массив_basicTypeCast()source protected
_basicTypeCast( mixed $value )
Проверяет, является ли этот тип базовым и может ли он быть преобразован с помощью обратного вызова. Если да, возвращает преобразованное значение.
Устаревшее
3.1 Все типы теперь должны быть определёнными классамиПараметры
- mixed
$value - Значение, которое нужно преобразовать в PHP-эквивалент
Возвращает
mixedboolval()source public static
boolval( mixed $value )
Преобразователь типа для логических значений.
Преобразует строки true/false в булевы значения.
Устаревшее
3.1.8 Этот метод больше не используется.Параметры
- mixed
$value - Значение, которое нужно преобразовать в булево.
Возвращает
booleanbuild()source public static
build( string $name )
Возвращает объект Type, способный преобразовать тип, идентифицированный по имени.
Параметры
- string
$name - идентификатор типа
Возвращает
Cake\Database\TypeИсключения
InvalidArgumentExceptionЕсли идентификатор типа неизвестен
buildAll()source public static
buildAll( )
Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени.
Возвращает
arrayclear()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|string[]|Cake\Database\Type[]|null $type null , string|Cake\Database\Type|null $className null )
Регистрирует новый идентификатор типа и сопоставляет его с полным именем класса с полным пространством имён. Если вызвана без аргументов, она вернет текущий массив сопоставлений типов. Если $className опущено, она вернет сопоставленный класс для $type.
Устарело: Использование $type как \Cake\Database\Type[] устарело. Пожалуйста, всегда используйте string[] если вы передаете массив в качестве первого аргумента.
Параметры
- 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 )
Возвращает объект Type, способный преобразовать тип, идентифицированный по $name
Параметры
- string
$name - Идентификатор типа, который вы хотите установить.
-
Cake\Database\Type$instance - Экземпляр типа, который вы хотите установить.
strval()source public static
strval( mixed $value )
Преобразователь типа для строковых значений.
Преобразует значения в строки
Устаревшее
3.1.8 Этот метод больше не используется.Параметры
- mixed
$value - Значение, которое нужно преобразовать в строку.
Возвращает
stringПодробное описание свойств
$dateTimeClasssource
public static string
Класс, используемый для представления объектов даты
Это свойство может быть использовано только до создания экземпляра этого типа класса. После этого используйте useMutable() или useImmutable() вместо него.
Устаревшее
3.2.0 Используйте DateType::useMutable() или DateType::useImmutable() вместо этого.'Cake\I18n\Date'
© 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.DateType.html