Класс TimeType

Конвертер типа времени.

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

Namespace: Cake\Database\Type

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

$_className protected

string

Имя класса, используемое при создании объектов.
$_format protected

string

Формат DateTime, используемый при преобразовании в строку.
$_localeMarshalFormat protected

string|array|int

Формат с учетом локали marshal() используется, когда _useLocaleParser равно true.
$_marshalFormats protected

array

Форматы DateTime, разрешенные marshal().
$_name protected

string|null

Идентификатор имени для этого типа
$_useLocaleMarshal protected

bool

Должен ли marshal() использовать анализатор с учетом локали с _localeMarshalFormat.
$dbTimezone protected

DateTimeZone|null

Часовой пояс базы данных.
$defaultTimezone protected

DateTimeZone

Часовой пояс по умолчанию.
$keepDatabaseTimezone protected

bool

Сохраняется ли часовой пояс базы данных при преобразовании
$setToDateStart protected

bool

Следует ли переопределять время преобразованных объектов Time, чтобы оно указывало на начало дня.

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

__construct() public

Конструктор
_parseLocaleValue() protected

Преобразует строку в объект DateTime после её анализа с помощью анализатора с учётом локали и формата, заданного setLocaleFormat().
_parseValue() protected

Преобразует строку в объект DateTime после её анализа с использованием форматов в _marshalFormats.
_setClassName() protected

Задает имя класса, используемое при построении объектов.
getBaseType() public

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

Получает имя класса, используемое для построения объектов.
getName() public

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

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

Преобразует данные запроса в объект datetime.
newId() public

Генерирует новое значение первичного ключа для данного типа.
setDatabaseTimezone() public

Устанавливает часовой пояс базы данных.
setKeepDatabaseTimezone() public

Устанавливает, преобразуется ли объект DateTime, созданный из строки базы данных, в часовой пояс по умолчанию.
setLocaleFormat() public

Устанавливает формат с учетом локали, используемый marshal() при анализе строк.
setTimezone() public deprecated

Псевдоним для setDatabaseTimezone().
toDatabase() public

Преобразует экземпляр DateTime в строки.
toPHP() public

Преобразует заданное значение из типа базы данных в эквивалент PHP.
toStatement() public

Преобразует заданное значение в эквивалент Statement
useImmutable() public

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

Устанавливает, следует ли анализировать строки, переданные в marshal(), используя формат с учетом локали, установленный setLocaleFormat().
useMutable() public

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

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

__construct() public

__construct(string|null $name = null)

Конструктор

Параметры

string|null $name optional: Имя, идентифицирующее этот тип

_parseLocaleValue() protected

_parseLocaleValue(string $value): Cake\I18n\I18nDateTimeInterface|null

Преобразует строку в объект DateTime после анализа с помощью анализатора, учитывающего локаль, с форматом, установленным setLocaleFormat().

Параметры

string $value

Возвращает

Cake\I18n\I18nDateTimeInterface|null

_parseValue() protected

_parseValue(string $value): DateTimeInterface|null

Преобразует строку в объект DateTime после анализа с использованием форматов в _marshalFormats.

Параметры

string $value: Значение для анализа и преобразования в объект.

Возвращает

DateTimeInterface|null

_setClassName() protected

_setClassName(string $class, string $fallback): void

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

Параметры

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

Возвращает

void

getBaseType() public

getBaseType(): string|null

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

Это полезно при расширении базового типа для добавления дополнительной функциональности, но при этом требуется, чтобы остальная часть фреймворка использовала те же предположения, которые она делала бы относительно базового типа, от которого он наследуется.

Возвращает

string|null

getDateTimeClassName() public

getDateTimeClassName(): string

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

Возвращает

string

getName() public

getName(): string|null

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

Возвращает

string|null

manyToPHP() public

manyToPHP(array $values, string[] $fields, Cake\Database\DriverInterface $driver): array

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

Параметры

array $values
string[] $fields
Cake\Database\DriverInterface $driver

Возвращает

array

marshal() public

marshal(mixed $value): DateTimeInterface|null

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

Наиболее полезно для преобразования данных запроса в PHP-объекты, которые имеют смысл для остальных слоев ORM/базы данных.

Параметры

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

Возвращает

DateTimeInterface|null

newId() public

newId(): mixed

Генерирует новое значение первичного ключа для заданного типа.

Этот метод может использоваться типами для создания новых значений первичных ключей при вставке сущностей.

Возвращает

mixed

setDatabaseTimezone() public

setDatabaseTimezone(stringDateTimeZone|null $timezone): $this

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

Это часовой пояс, используемый при преобразовании строк базы данных в экземпляры DateTime и преобразовании экземпляров DateTime в строки базы данных.

Параметры

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

Возвращает

$this

См. также

DateTimeType::setKeepDatabaseTimezone

setKeepDatabaseTimezone() public

setKeepDatabaseTimezone(bool $keep): $this

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

Если ваши даты и время в базе данных находятся в определенном часовом поясе, который вы хотите сохранить в экземпляре DateTime, установите это значение в true.

Если false, часовые пояса datetime преобразуются в часовой пояс по умолчанию. Это поведение по умолчанию.

Параметры

bool $keep: Если true, часовой пояс базы данных сохраняется при преобразовании в экземпляры DateTime.

Возвращает

$this

setLocaleFormat() public

setLocaleFormat(string|array $format): $this

Устанавливает формат, учитывающий локаль, используемый marshal() при анализе строк.

См. Cake\I18n\Time::parseDateTime() для допустимых форматов.

Параметры

string|array $format: Формат, учитывающий локаль

Возвращает

$this

См. также

\Cake\I18n\Time::parseDateTime()

setTimezone() public

setTimezone(stringDateTimeZone|null $timezone): $this

Псевдоним для setDatabaseTimezone().

Параметры

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

Возвращает

$this

toDatabase() public

toDatabase(mixed $value, Cake\Database\DriverInterface $driver): string|null

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

Параметры

mixed $value: Значение для преобразования.
Cake\Database\DriverInterface $driver: Экземпляр драйвера для преобразования.

Возвращает

string|null

toPHP() public

toPHP(mixed $value, Cake\Database\DriverInterface $driver): DateTimeInterface|null

Преобразует заданное значение из типа базы данных в эквивалент PHP.

Параметры

mixed $value: Значение для преобразования в эквивалент PHP
Cake\Database\DriverInterface $driver: Объект, из которого будут извлечены настройки и конфигурация базы данных

Возвращает

DateTimeInterface|null

toStatement() public

toStatement(mixed $value, Cake\Database\DriverInterface $driver): mixed

Преобразует заданное значение в эквивалент Statement

Параметры

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

Возвращает

mixed

useImmutable() public

useImmutable(): $this

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

Возвращает

$this

useLocaleParser() public

useLocaleParser(bool $enable = true): $this

Устанавливает, следует ли анализировать строки, переданные в marshal(), используя формат, учитывающий локаль, установленный setLocaleFormat().

Параметры

bool $enable optional: Включать или нет

Возвращает

$this

useMutable() public

useMutable(): $this

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

Возвращает

$this

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

`$_className` protected

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

Тип

string

`$_format` protected

Формат даты и времени, используемый при преобразовании в строку.

Тип

string

`$_localeMarshalFormat` protected

Формат с учетом локали marshal() используется, когда _useLocaleParser равно true.

См. Cake\I18n\Time::parseDateTime() для допустимых форматов.

Тип

string|array|int

`$_marshalFormats` protected

Форматы даты и времени, разрешенные marshal().

Тип

array

`$_name` protected

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

Тип

string|null

`$_useLocaleMarshal` protected

Должен ли marshal() использовать анализатор с учетом локали с _localeMarshalFormat.

Тип

bool

`$dbTimezone` protected

Часовой пояс базы данных.

Тип

DateTimeZone|null

`$defaultTimezone` protected

Часовой пояс по умолчанию.

Тип

DateTimeZone

`$keepDatabaseTimezone` protected

Сохраняется ли часовой пояс базы данных при преобразовании

Тип

bool

`$setToDateStart` protected

Необходимо ли переопределить время преобразованных объектов Time, чтобы оно указывало на начало дня.

Это в основном для того, чтобы подклассам не приходилось повторно реализовывать одну и ту же функциональность.

Тип

bool

© 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/4.2/class-Cake.Database.Type.TimeType.html

Класс TimeType

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

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

__construct() public

_parseLocaleValue() protected

_parseValue() protected

_setClassName() protected

getBaseType() public

getDateTimeClassName() public

getName() public

manyToPHP() public

marshal() public

newId() public

setDatabaseTimezone() public

setKeepDatabaseTimezone() public

setLocaleFormat() public

setTimezone() public deprecated

toDatabase() public

toPHP() public

toStatement() public

useImmutable() public

useLocaleParser() public

useMutable() public

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

__construct() public

Параметры

_parseLocaleValue() protected

Параметры

Возвращает

_parseValue() protected

Параметры

Возвращает

_setClassName() protected

Параметры

Возвращает

getBaseType() public

Возвращает

getDateTimeClassName() public

Возвращает

getName() public

Возвращает

manyToPHP() public

Параметры

Возвращает

marshal() public

Параметры

Возвращает

newId() public

Возвращает

setDatabaseTimezone() public

Параметры

Возвращает

См. также

setKeepDatabaseTimezone() public

Параметры

Возвращает

setLocaleFormat() public

Параметры

Возвращает

См. также

setTimezone() public

Параметры

Возвращает

toDatabase() public

Параметры

Возвращает

toPHP() public

Параметры

Возвращает

toStatement() public

Параметры

Возвращает

useImmutable() public

Возвращает

useLocaleParser() public

Параметры

Возвращает

useMutable() public

Возвращает

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

`$_className` protected

`$_format` protected

`$_localeMarshalFormat` protected

`$_marshalFormats` protected

`$_name` protected

`$_useLocaleMarshal` protected

`$dbTimezone` protected

`$defaultTimezone` protected

`$keepDatabaseTimezone` protected

`$setToDateStart` protected