Класс DateTimeType
Конвертер типа DateTime.
Используется для преобразования экземпляров datetime в строки и обратно.
- Cake\Database\Type
-
Cake\Database\Type\DateTimeType
Непосредственные известные подклассы
Cake\Database\Type\DateType, Cake\Database\Type\TimeTypeПодробное описание метода
__constructsource public
__construct( string $name null )
Конструктор
Параметры
- строка
$nameнеобязательно null - Имя, идентифицирующее этот тип
Переопределяет
Cake\Database\Type::__construct() _parseValuesource protected
_parseValue( string $value )
Преобразует строку в объект DateTime после её разбора с помощью регионально-зависимого анализатора с указанным форматом.
Параметры
- строка
$value - Значение для разбора и преобразования в объект.
Возвращает
Cake\I18n\Time|null\Cake\I18n\Time|null
marshalsource public
marshal( mixed $value )
Преобразование данных запроса в объект datetime.
Параметры
- смешанное
$value - Данные запроса
Возвращает
Cake\I18n\Time|DateTime\Cake\I18n\Time|\DateTime
Переопределяет
Cake\Database\Type::marshal() setLocaleFormatsource public
setLocaleFormat( string|array $format )
Устанавливает строку формата для разбора дат в этом классе. Форматы, которые принимаются, документированы в функции Cake\I18n\Time::parseDateTime().
Параметры
- строка/массив
$format - Формат, в котором передаются строки.
Возвращает
mixed$this
См.
Cake\I18n\Time::parseDateTime()toDatabasesource public
toDatabase( string|integer|DateTime $value , Cake\Database\Driver $driver )
Преобразование экземпляра DateTime в строки.
Параметры
- строка|целое число|DateTime
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
stringстрока
Переопределяет
Cake\Database\Type::toDatabase() toPHPsource public
toPHP( string $value , Cake\Database\Driver $driver )
Преобразование строк в экземпляры DateTime.
Параметры
- строка
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
Cake\I18n\Time|DateTime\Cake\I18n\Time|\DateTime
Переопределяет
Cake\Database\Type::toPHP() useLocaleParsersource public
useLocaleParser( boolean $enable true )
Устанавливает, использовать ли регионально-зависимый анализатор для разбора дат, передаваемых в функцию marshal().
Параметры
- логическое значение
$enableнеобязательно true - Включить или отключить
Возвращает
mixed$this
Методы, унаследованные от Cake\Database\Type
_basicTypeCastsource protected
_basicTypeCast( mixed $value )
Проверяет, является ли этот тип базовым, и может ли он быть преобразован с помощью обратного вызова. Если это так, возвращает преобразованное значение
Устарело
3.1 Все типы теперь должны быть отдельным классомПараметры
- смешанное
$value - значение, которое требуется преобразовать в эквивалент PHP
Возвращает
mixedсмешанное
boolvalsource public static
boolval( mixed $value )
Конвертер типов для булевых значений.
Преобразует строковые значения true/false в булевы.
Устарело
3.1.8 Этот метод больше не используется.Параметры
- смешанное
$value - Значение для преобразования в булевое.
Возвращает
booleanлогическое значение
buildsource public static
build( string $name )
Возвращает объект Type, способный преобразовать тип, идентифицированный по $name
Параметры
- строка
$name - идентификатор типа
Возвращает
Cake\Database\TypeType
Исключения
InvalidArgumentExceptionЕсли идентификатор типа неизвестен
clearsource public static
clear( )
Очищает все созданные экземпляры и сопоставленные классы типов, полезно для тестирования
getBaseTypesource public
getBaseType( )
Возвращает имя базового типа, от которого наследуется этот класс. Это полезно при расширении базового типа для добавления дополнительной функциональности, но при этом вы хотите, чтобы остальная часть фреймворка использовала те же предположения о базовом типе, от которого он унаследован.
Возвращает
stringстрока
getNamesource public
getName( )
Возвращает имя идентификатора типа для этого объекта
Возвращает
stringстрока
mapsource public static
map( string|array|Cake\Database\Type|null $type null , string|null $className null )
Регистрирует новый идентификатор типа и сопоставляет его с полным именованным именем класса. Если вызвана без аргументов, она вернёт текущий массив типов. Если $className опущен, она вернёт сопоставленный класс для $type.
Параметры
- строка/массив/
Cake\Database\Type|null$typeнеобязательно null - если строка, имя типа для сопоставления; если массив, список массивов для сопоставления
- строка|null
$classNameнеобязательно null - Имя класса для регистрации.
Возвращает
array|string|nullесли $type равен null, то массив с текущим отображением; если $className равен null, то строка сопоставленного имени класса для данного $type; в противном случае null
newIdsource public
newId( )
Генерирует новое значение первичного ключа для заданного типа.
Этот метод может использоваться типами для создания новых значений первичных ключей при вставке сущностей.
Возвращает
mixedНовое значение первичного ключа.
См.
Cake\Database\Type\UuidTypesetsource public static
set( string $name , Cake\Database\Type $instance )
Возвращает объект Type, способный преобразовать тип, идентифицированный по $name
Параметры
- строка
$name - Идентификатор типа, который требуется установить.
-
Cake\Database\Type$instance - Экземпляр типа, который требуется установить.
strvalsource public static
strval( mixed $value )
Преобразователь типа для строковых значений.
Преобразует значения в строки.
Устаревшее
3.1.8 Этот метод больше не используется.Параметры
- mixed
$value - Значение, которое нужно преобразовать в строку.
Возвращает
booleanbool
toStatementsource public
toStatement( mixed $value , Cake\Database\Driver $driver )
Преобразует заданное значение в эквивалент оператора.
Параметры
- mixed
$value - Значение, которое необходимо преобразовать в PHP эквивалент.
-
Cake\Database\Driver$driver - Объект, из которого будут извлечены настройки и конфигурация базы данных.
Возвращает
mixedmixed
Резюме свойств
Наследуемые свойства из Cake\Database\Type
$_basicTypessource
protected static array
Список базовых сопоставлений типов, используемых для избежания необходимости создания класса для преобразования этих типов.
Устаревшее
3.1 Все типы теперь будут использовать определенный класс[
'string' => ['callback' => ['\Cake\Database\Type', 'strval']],
'text' => ['callback' => ['\Cake\Database\Type', 'strval']],
'boolean' => [
'callback' => ['\Cake\Database\Type', 'boolval'],
'pdo' => PDO::PARAM_BOOL
],
] $_builtTypessource
protected static array
Содержит карту экземпляров объектов типа для повторного использования при необходимости.
[]
$_typessource
protected static array
Список поддерживаемых типов баз данных. В качестве ключа используется удобочитаемый идентификатор, а в качестве значения — полное имя пространства имен класса, представляющее класс, который будет выполнять фактические преобразования типов.
[
'biginteger' => 'Cake\Database\Type\IntegerType',
'binary' => 'Cake\Database\Type\BinaryType',
'boolean' => 'Cake\Database\Type\BoolType',
'date' => 'Cake\Database\Type\DateType',
'datetime' => 'Cake\Database\Type\DateTimeType',
'decimal' => 'Cake\Database\Type\FloatType',
'float' => 'Cake\Database\Type\FloatType',
'integer' => 'Cake\Database\Type\IntegerType',
'string' => 'Cake\Database\Type\StringType',
'text' => 'Cake\Database\Type\StringType',
'time' => 'Cake\Database\Type\TimeType',
'timestamp' => 'Cake\Database\Type\DateTimeType',
'uuid' => 'Cake\Database\Type\UuidType',
]
© 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.1/class-Cake.Database.Type.DateTimeType.html