Класс TimeType
Конвертер типов времени.
Используется для преобразования экземпляров времени в строки и обратно.
- Cake\Database\Type implements Cake\Database\TypeInterface
-
Cake\Database\Type\DateTimeType implements Cake\Database\TypeInterface
-
Cake\Database\Type\TimeType
Краткое описание свойств
-
$_formatprotectedФормат времени для объекта DateTimestring|array
Унаследованные свойства
-
_className,_datetimeInstance,_localeFormat,_name,_useLocaleParser,dateTimeClass_basicTypes,_builtTypes,_types
Краткое описание методов
- _parseValue() protected
Преобразует строку в объект DateTime после её разбора с помощью локализованного парсера с указанным форматом.
Подробное описание методов
_parseValue()source protected
_parseValue( string $value )
Преобразует строку в объект DateTime после её разбора с помощью локализованного парсера с указанным форматом.
Параметры
- строка
$value - Значение для разбора и преобразования в объект.
Возвращает
Cake\I18n\Time|nullПереопределяет
Cake\Database\Type\DateTimeType::_parseValue() Методы, унаследованные от 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( )
Получить имя класса, используемого для создания объектов.
Возвращает
строкаmarshal()source public
marshal( mixed $value )
Преобразовать данные запроса в объект datetime.
Параметры
- смешанное
$value - Данные запроса
Возвращает
DateTimeInterfaceПереопределяет
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 - Экземпляр драйвера для преобразования.
Возвращает
строка|nullПереопределяет
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|nullПереопределяет
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().
Параметры
- булево
$enableнеобязательно true - Включить или выключить
Возвращает
$this
useMutable()source public
useMutable( )
Изменение имени предпочтительного класса на реализацию изменяемого времени.
Возвращает
$this
Методы, унаследованные от Cake\Database\Type
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
массив_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 - идентификатор типа
Возвращает
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|string[]|Cake\Database\Type[]|null $type null , string|Cake\Database\Type|null $className null )
Регистрирует новый идентификатор типа и сопоставляет его с полным именем класса с пространством имён. Если вызван без аргументов, вернёт текущий массив сопоставлений типов. Если $className опущен, вернёт сопоставленный класс для $type.
Устаревшее: Использование $type как \Cake\Database\Type[] устарело. Пожалуйста, всегда используйте string[] при передаче массива в качестве первого аргумента.
Параметры
- строка|массив строк|
Cake\Database\Type[]|null$typeнеобязательно null - Если строка - имя типа для сопоставления, если массив - список массивов для сопоставления
- строка|
Cake\Database\Type|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 - Значение, которое нужно преобразовать в строку.
Возвращает
строкаПодробное описание свойств
© 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.TimeType.html