Spec-Zone.ru › CakePHP 3.6

Класс TimeType

Преобразователь типа времени.

Используется для преобразования экземпляров времени в строки и обратно.

Cake\Database\Type implements Cake\Database\TypeInterface
Extended by Cake\Database\Type\DateTimeType implements Cake\Database\TypeInterface, Cake\Database\Type\BatchCastingInterface
Extended by Cake\Database\Type\TimeType
Пространство имён: Cake\Database\Type
Расположение: Database/Type/TimeType.php

Краткое описание свойств

  • $_format protected
    string|array
    Формат времени для объекта DateTime

Унаследованные свойства

  • _className, _datetimeInstance, _localeFormat, _name, _useLocaleParser, dateTimeClass, dbTimezone, setToDateStart _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()
END_OF_DOCUMENT_MARKER

_compare()source protected

_compare( Cake\I18n\Time|DateTime $date , mixed $value )

Параметры

Cake\I18n\Time|DateTime $date
Объект DateTime
mixed $value
Данные запроса

Возвращает

boolean

_setClassName()source protected

_setClassName( string $class , string $fallback )

Установите имя класса для использования при создании объектов.

Параметры

string $class
Имя используемого класса.
string $fallback
Имя класса для использования, если предпочтительный класс отсутствует.

getDateTimeClassName()source public

getDateTimeClassName( )

Получить имя класса, используемого для создания объектов.

Возвращает

string

manyToPHP()source public

manyToPHP( array $values , array $fields , Cake\Database\Driver $driver )

Возвращает массив значений, преобразованных в представление PHP этого типа.

Параметры

array $values
Исходный массив значений, содержащий поля для преобразования
array $fields
Ключи полей для преобразования
Cake\Database\Driver $driver
Объект, из которого будут извлечены настройки и конфигурация базы данных.

Возвращает

array

Реализация

Cake\Database\Type\BatchCastingInterface::manyToPHP()

marshal()source public

marshal( mixed $value )

Преобразование данных запроса в объект datetime.

Параметры

mixed $value
Данные запроса

Возвращает

DateTimeInterface|null

Переопределяет

Cake\Database\Type::marshal()

Реализация

Cake\Database\TypeInterface::marshal()

setLocaleFormat()source public

setLocaleFormat( string|array $format )

Устанавливает строку формата для разбора дат в этом классе. Форматы, которые принимаются, документированы в функции Cake\I18n\Time::parseDateTime().

Параметры

string|array $format
Формат, в котором передаются строки.

Возвращает


$this

См. также

\Cake\I18n\Time::parseDateTime()

setTimezone()source public

setTimezone( string|DateTimeZone|null $timezone )

Установить часовой пояс базы данных.

Указанный часовой пояс будет установлен для объектов DateTime перед генерацией строки даты и времени для сохранения в базе данных. Если null, преобразование часовых поясов не будет выполнено.

Параметры

string|DateTimeZone|null $timezone
Часовой пояс базы данных.

Возвращает


$this

toDatabase()source public

toDatabase( string|integer|DateTime|DateTimeImmutable $value , Cake\Database\Driver $driver )

Преобразование экземпляра DateTime в строки.

Параметры

string|integer|DateTime|DateTimeImmutable $value
Значение для преобразования.
Cake\Database\Driver $driver
Экземпляр драйвера для преобразования.

Возвращает

string|null

Переопределяет

Cake\Database\Type::toDatabase()

Реализация

Cake\Database\TypeInterface::toDatabase()

toPHP()source public

toPHP( string $value , Cake\Database\Driver $driver )

Преобразование строк в экземпляры DateTime.

Параметры

string $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

Параметры

mixed $value
Значение, которое необходимо преобразовать в оператор PDO.
Cake\Database\Driver $driver
Объект, из которого будут извлечены настройки и конфигурация базы данных.

Возвращает

mixed

Переопределяет

Cake\Database\Type::toStatement()

Реализация

Cake\Database\TypeInterface::toStatement()

useImmutable()source public

useImmutable( )

Изменить предпочтительное имя класса на реализацию FrozenTime.

Возвращает


$this

useLocaleParser()source public

useLocaleParser( boolean $enable = true )

Устанавливает, использовать ли при разборе дат в функции marshal() локально-ориентированный парсер.

Параметры

boolean $enable по умолчанию true
Включить или выключить

Возвращает


$this

useMutable()source public

useMutable( )

Изменить предпочтительное имя класса на реализацию mutable Time.

Возвращает


$this

Методы, унаследованные от Cake\Database\Type

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array

_basicTypeCast()source protected deprecated

_basicTypeCast( mixed $value )

Проверяет, является ли этот тип базовым и может ли он быть преобразован с помощью обратного вызова. Если это так, возвращает преобразованное значение.

Устарело

3.1 Все типы теперь должны быть конкретным классом

Параметры

mixed $value
Значение, которое должно быть преобразовано в эквивалент PHP

Возвращает

mixed

boolval()source public static deprecated

boolval( mixed $value )

Преобразователь типов для логических значений.

Преобразует строки true/false в булевы значения.

Устарело

3.1.8 Этот метод больше не используется.

Параметры

mixed $value
Значение для преобразования в булево значение.

Возвращает

boolean

build()source public static

build( string $name )

Возвращает объект Type, способный преобразовать тип, идентифицируемый по имени.

Параметры

string $name
идентификатор типа

Возвращает

Cake\Database\Type

Исключения

InvalidArgumentException
Если идентификатор типа неизвестен

buildAll()source public static

buildAll( )

Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени.

Возвращает

array

clear()source public static

clear( )

Очищает все созданные экземпляры и сопоставленные типы классов, полезно для тестирования

getBaseType()source public

getBaseType( )

Возвращает базовое имя типа, от которого наследуется этот класс.

Возвращает

string
Имя базового типа, от которого наследуется этот класс.

Реализация

Cake\Database\TypeInterface::getBaseType()

getMap()source public static

getMap( string|null $type = null )

Получить имя сопоставленного класса или экземпляр для типа(ов).

Параметры

string|null $type необязательно null
Имя типа, для которого нужно получить сопоставленный класс, или null для получения массива сопоставлений.

Возвращает

array|string|Cake\Database\TypeInterface|null
Настроенное имя класса или экземпляр для данного $type или массив сопоставлений.

С версии

3.6.2

getName()source public

getName( )

Возвращает имя идентификатора типа для этого объекта.

Возвращает

string
Имя идентификатора типа для этого объекта.

Реализация

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.

Устарело 3.6.2: - Использование $type как string[]|\Cake\Database\Type[] устарело. Используйте Type::setMap() со string[] вместо этого. - Передача $className как \Cake\Database\Type экземпляр устарела, используйте только строку с именем класса. - Использование этого метода в качестве получателя устарело. Используйте Type::getMap() вместо этого.

Параметры

string|string[]|Cake\Database\Type[]|null $type необязательно null
Если строка имя типа для сопоставления, если массив список массивов для сопоставления
string|Cake\Database\Type|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
Экземпляр типа, который вы хотите установить.

setMap()source public static

setMap( array $map )

Устанавливает сопоставление типа с именем класса.

Параметры

array $map
Список типов для сопоставления.

С версии

3.6.2

strval()source public static deprecated

strval( mixed $value )

Преобразователь типов для строковых значений.

Преобразует значения в строки.

Устарело

3.1.8 Этот метод больше не используется.

Параметры

mixed $value
Значение для преобразования в строку.

Возвращает

string

Подробное описание свойств

$_formatsource

protected string|array

Формат времени для объекта DateTime

'H:i:s'

© 2005–present 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.6/class-Cake.Database.Type.TimeType.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API