Класс 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 - Входные данные запроса
Возвращает
DateTimeПереопределяет
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 - Экземпляр драйвера для преобразования.
Возвращает
строкаПереопределяет
Cake\Database\Type::toDatabase() Реализация
Cake\Database\TypeInterface::toDatabase() toStatement()source public
toStatement( mixed $value , Cake\Database\Driver $driver )
Преобразование данного значения в эквивалент оператора SQL.
Параметры
- смешанное
$value - Значение, которое нужно преобразовать в оператор PDO.
-
Cake\Database\Driver$driver - Объект, из которого будут извлечены параметры и настройки базы данных.
Возвращает
смешанноеПереопределяет
Cake\Database\Type::toStatement() Реализация
Cake\Database\TypeInterface::toStatement() useLocaleParser()source public
useLocaleParser( boolean $enable true )
Устанавливает, использовать ли локально-чувствительный парсер для разбора дат в функции marshal().
Параметры
- логическое значение
$enableопционально true - Включить или отключить
Возвращает
$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 Этот метод больше не используется.Параметры
- mixed
$value - Значение, которое нужно преобразовать в булевое значение.
Возвращает
booleanbuild()source public static
build( string $name )
Возвращает объект типа, способный преобразовывать тип, определяемый $name.
Параметры
- 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|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 )
Возвращает объект типа, способный преобразовать тип, определённый $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–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.DateType.html