Spec-Zone.ru › CakePHP 4.3

Класс DateTimeTimezoneType

Расширяет DateTimeType с поддержкой часовых поясов.

Пространство имён: Cake\Database\Type

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

  • $_className protected
    string

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

  • $_format protected
    string

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

  • $_localeMarshalFormat protected
    array|string|int

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

  • $_marshalFormats protected
    array<string>

    Форматы 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, чтобы они указывали на начало дня.

  • $userTimezone protected
    DateTimeZone|null

    Пользовательский часовой пояс.

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

  • __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().

  • setUserTimezone() public

    Устанавливает пользовательский часовой пояс.

  • toDatabase() public

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

  • toPHP() public

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

  • toStatement() public

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

  • useImmutable() public deprecated

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

  • useLocaleParser() public

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

  • useMutable() public deprecated

    Изменить предпочтительное имя класса на реализацию mutable 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, array<string> $fields, Cake\Database\DriverInterface $driver): array

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

Параметры

array $values
array<string> $fields
Cake\Database\DriverInterface $driver

Возвращаемое значение

array

marshal() public 

marshal(mixed $value): DateTimeInterface|null

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

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

Параметры

mixed $value

Данные запроса

Возвращаемое значение

DateTimeInterface|null

newId() public 

newId(): mixed

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

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

Возвращаемое значение

mixed

setDatabaseTimezone() public 

setDatabaseTimezone(DateTimeZone|string|null $timezone): $this

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

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

Параметры

DateTimeZone|string|null $timezone

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

Возвращаемое значение

$this

См. также

DateTimeType::setKeepDatabaseTimezone

setKeepDatabaseTimezone() public 

setKeepDatabaseTimezone(bool $keep): $this

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

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

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

Параметры

bool $keep

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

Возвращаемое значение

$this

setLocaleFormat() public 

setLocaleFormat(array|string $format): $this

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

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

Параметры

array|string $format

Формат, учитывающий локаль

Возвращаемое значение

$this

См. также

\Cake\I18n\Time::parseDateTime()

setTimezone() public 

setTimezone(DateTimeZone|string|null $timezone): $this

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

Параметры

DateTimeZone|string|null $timezone

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

Возвращаемое значение

$this

setUserTimezone() public 

setUserTimezone(DateTimeZone|string|null $timezone): $this

Устанавливает часовой пояс пользователя.

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

Параметры

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

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

Тип

string

$_localeMarshalFormat protected

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

См. Cake\I18n\Time::parseDateTime(), чтобы ознакомиться с допустимыми форматами.

Тип

array|string|int

$_marshalFormats protected

Допустимые форматы DateTime, разрешенные marshal().

Тип

array<string>

$_name protected

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

Тип

string|null

$_useLocaleMarshal protected

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

Тип

bool

$dbTimezone protected

Временная зона базы данных.

Тип

DateTimeZone|null

$defaultTimezone protected

Временная зона по умолчанию.

Тип

DateTimeZone

$keepDatabaseTimezone protected

Сохранять ли временную зону базы данных при преобразовании.

Тип

bool

$setToDateStart protected

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

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

Тип

bool

$userTimezone protected

Временная зона пользователя.

Тип

DateTimeZone|null

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

Spec-Zone.ru

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