Класс DateType
Конвертер типа даты и времени.
Используется для преобразования экземпляров даты и времени в строки и обратно.
- Cake\Database\Type
-
Cake\Database\Type\DateTimeType -
Cake\Database\Type\DateType
Подробное описание методов
_parseValueисходный код protected
_parseValue( string $value )
Преобразует строку в объект DateTime после её разбора с использованием локализованного парсера со специфицированным форматом.
Параметры
- строка
$value - Значение для разбора и преобразования в объект.
Возвращает
Cake\I18n\Time|null\Cake\I18n\Time|null
Переопределяет
Cake\Database\Type\DateTimeType::_parseValue() marshalисходный код public
marshal( mixed $value )
Преобразует данные запроса в объект datetime.
Параметры
- смешанный
$value - Данные запроса
Возвращает
DateTime\DateTime
Переопределяет
Cake\Database\Type\DateTimeType::marshal() toPHPисходный код public
toPHP( string $value , Cake\Database\Driver $driver )
Преобразование строк в экземпляры Date.
Параметры
- строка
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
Carbon\Carbon\Carbon\Carbon
Переопределяет
Cake\Database\Type\DateTimeType::toPHP() Методы, унаследованные от Cake\Database\Type\DateTimeType
__constructисходный код public
__construct( string $name null )
Конструктор
Параметры
- строка
$nameнеобязательно null - Имя, идентифицирующее этот тип
Переопределяет
Cake\Database\Type::__construct() setLocaleFormatисходный код public
setLocaleFormat( string|array $format )
Устанавливает строку формата для разбора дат в этом классе. Форматы, которые принимаются, документированы в функции Cake\I18n\Time::parseDateTime().
Параметры
- строка|массив
$format - Формат, в котором передаются строки.
Возвращает
mixed$this
См. также
Cake\I18n\Time::parseDateTime()toDatabaseисходный код public
toDatabase( string|integer|DateTime $value , Cake\Database\Driver $driver )
Преобразование экземпляра DateTime в строки.
Параметры
- строка|целое число|DateTime
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
stringстрока
Переопределяет
Cake\Database\Type::toDatabase() useLocaleParserисходный код public
useLocaleParser( boolean $enable true )
Устанавливает, использовать ли локализованный парсер для разбора дат, передаваемых в функцию marshal().
Параметры
- логическое значение
$enableнеобязательно true - Включить или выключить
Возвращает
mixed$this
Методы, унаследованные от Cake\Database\Type
_basicTypeCastисходный код protected
_basicTypeCast( mixed $value )
Проверяет, является ли этот тип базовым и может ли он быть преобразован с помощью обратного вызова. Если это так, возвращает преобразованное значение.
Устарело
3.1 Все типы теперь должны быть отдельными классамиПараметры
- смешанный
$value - значение, подлежащее преобразованию в PHP-эквивалент
Возвращает
mixedсмешанный
boolvalисходный код public static
boolval( mixed $value )
Конвертер типа для булевых значений.
Преобразует строковые значения true/false в булевые.
Устарело
3.1.8 Этот метод больше не используется.Параметры
- смешанный
$value - Значение для преобразования в булевое.
Возвращает
booleanbool
buildисходный код public static
build( string $name )
Возвращает объект Type, способный преобразовать тип, определённый $name.
Параметры
- строка
$name - идентификатор типа
Возвращает
Cake\Database\TypeType
Вызывает исключение
InvalidArgumentExceptionЕсли идентификатор типа неизвестен
clearисходный код public static
clear( )
Очищает все созданные экземпляры и сопоставленные классы типов, полезно для тестирования.
getBaseTypeисходный код public
getBaseType( )
Возвращает имя базового типа, от которого наследуется этот класс. Это полезно при расширении базового типа для добавления дополнительной функциональности, но при этом хочется, чтобы остальная часть фреймворка использовала те же предположения о базовом типе, от которого он наследуется.
Возвращает
stringстрока
getNameисходный код public
getName( )
Возвращает имя идентификатора типа для этого объекта.
Возвращает
stringстрока
mapисходный код 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
newIdисходный код public
newId( )
Генерирует новое значение первичного ключа для заданного типа.
Этот метод может использоваться типами для создания новых значений первичного ключа при вставке сущностей.
Возвращает
mixedНовое значение первичного ключа.
См. также
Cake\Database\Type\UuidTypesetисходный код 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 Этот метод больше не используется.Параметры
- смешанный
$value - Значение, которое нужно преобразовать в строку.
Возвращает
booleanbool
toStatementsource public
toStatement( mixed $value , Cake\Database\Driver $driver )
Преобразует данное значение в эквивалент Statement
Параметры
- смешанный
$value - значение, которое нужно преобразовать в PHP эквивалент
-
Cake\Database\Driver$driver - объект, из которого будут извлечены настройки и конфигурация базы данных
Возвращает
mixedсмешанный
Краткое описание свойств
Наследуемые свойства от Cake\Database\Type\DateTimeType
$_datetimeInstancesource
protected DateTime
Экземпляр настроенного класса dateTimeClass, используемый для быстрого создания новых экземпляров без вызова конструктора.
$_localeFormatsource
protected строка|массив|целое число
Формат даты для парсинга входящих дат для маршалинга.
$_useLocaleParsersource
protected логическое значение
Использовать ли локально-зависимый парсер дат при маршалинге строковых входов.
false Наследуемые свойства от Cake\Database\Type
$_basicTypessource
protected static массив
Список отображений основных типов, используемый для избежания необходимости создания класса для преобразования этих типов
Устаревший
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 массив
Содержит отображение экземпляров объектов типов для повторного использования, если необходимо
[]
$_typessource
protected static массив
Список поддерживаемых типов базы данных. Используется удобочитаемый идентификатор в качестве ключа и полное имя пространства имен класса в качестве значения, представляющего класс, который будет выполнять фактическое преобразование типов.
[
'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.DateType.html