Класс TimeType
Преобразователь типа времени.
Используется для преобразования экземпляров времени в строки и обратно.
- Cake\Database\Type implements Cake\Database\TypeInterface
-
Cake\Database\Type\DateTimeType implements Cake\Database\TypeInterface -
Cake\Database\Type\TimeType
Краткое описание свойств
-
$_formatprotectedФормат времени для объекта DateTimestring
Унаследованные свойства
-
_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() _setClassName()source protected
_setClassName( string $class , string $fallback )
Устанавливает имя класса для использования при создании объектов.
Параметры
- строка
$class - Имя класса для использования.
- строка
$fallback - Имя класса для использования, если предпочтительный класс отсутствует.
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
Параметры
- смешанное
$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( )
Изменяет имя предпочтительного класса на изменяемый класс Time.
Возвращает
$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 Этот метод больше не используется.Параметры
- смешанное
$value - Значение для преобразования в булевое значение.
Возвращает
булевое значениеbuild()source public static
build( string $name )
Возвращает объект Type, способный преобразовать тип, идентифицированный $name
Параметры
- строка
$name - идентификатор типа
Возвращает
Cake\Database\TypeВыбрасывает
InvalidArgumentExceptionЕсли идентификатор типа неизвестен
buildAll()source public static
buildAll( )
Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени
Возвращает
массив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Подробности свойств
© 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.TimeType.html