Spec-Zone.ru › CakePHP 3.8

Класс DateType

Класс DateType

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

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

  • $_format protected
    string|array
    Формат даты для объекта DateTime
  • $dateTimeClass public static
    string
    Класс для представления объектов даты
  • $setToDateStart protected
    boolean

    В этом классе мы хотим, чтобы у объектов Date время было установлено в начало дня.

Наследуемые свойства

  • _className, _datetimeInstance, _localeFormat, _name, _useLocaleParser, dbTimezone _basicTypes, _builtTypes, _types

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

  • _parseValue() protected

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

  • marshal() public
    Преобразовать данные запроса в объект datetime.
  • useImmutable() public
    Изменить предпочтительное имя класса на FrozenDate.
  • useMutable() public
    Изменить предпочтительное имя класса на изменяемый класс Date.

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

_parseValue()source protected

_parseValue( string $value )

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

Параметры

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

Возвращает

Cake\I18n\Time|null

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

Cake\Database\Type\DateTimeType::_parseValue()

marshal()source public

marshal( mixed $value )

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

Параметры

смешанный $value
Данные запроса

Возвращает

DateTimeInterface

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

Cake\Database\Type\DateTimeType::marshal()

useImmutable()source public

useImmutable( )

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

Возвращает


$this

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

Cake\Database\Type\DateTimeType::useImmutable()

useMutable()source public

useMutable( )

Изменить предпочтительное имя класса на изменяемый класс Date.

Возвращает


$this

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

Cake\Database\Type\DateTimeType::useMutable()

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

__construct()source public

__construct( string|null $name = null )

Конструктор

Параметры

строка|null $name необязательно null
Имя, идентифицирующее этот тип

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

Cake\Database\Type::__construct()

_compare()source protected

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

Параметры

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

Возвращает

boolean

_setClassName()source protected

_setClassName( string $class , string $fallback )

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

Параметры

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

getDateTimeClassName()source public

getDateTimeClassName( )

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

Возвращает

строка

manyToPHP()source public

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

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

Параметры

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

Возвращает

массив

Реализация

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

setLocaleFormat()source public

setLocaleFormat( string|array $format )

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

Параметры

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

Возвращает


$this

См. также

\Cake\I18n\Time::parseDateTime()

setTimezone()source public

setTimezone( string|DateTimeZone|null $timezone )

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

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

Параметры

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

Возвращает


$this

toDatabase()source public

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

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

Параметры

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

Возвращает

строка|null

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

Cake\Database\Type::toDatabase()

Реализация

Cake\Database\TypeInterface::toDatabase()

toPHP()source public

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

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

Параметры

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

Возвращает

Cake\I18n\Time|DateTime|null

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

Cake\Database\Type::toPHP()

Реализация

Cake\Database\TypeInterface::toPHP()
END_OF_DOCUMENT_MARKER ```

toStatement()source public

toStatement( mixed $value , Cake\Database\Driver $driver )

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

Параметры

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

Возвращает

смешанное

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

Cake\Database\Type::toStatement()

Реализация

Cake\Database\TypeInterface::toStatement()

useLocaleParser()source public

useLocaleParser( boolean $enable = true )

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

Параметры

логическое $enable необязательно true
Включить или выключить

Возвращает


$this

Наследуемые методы из Cake\Database\Type

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

_basicTypeCast()source protected устарело

_basicTypeCast( mixed $value )

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

Устарело

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

Параметры

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

Возвращает

смешанное

boolval()source public статический устарело

boolval( mixed $value )

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

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

Устарело

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

Параметры

смешанное $value
Значение, которое нужно преобразовать в булево.

Возвращает

логическое

build()source public статический

build( string $name )

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

Параметры

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

Возвращает

Cake\Database\Type

Исключения

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

buildAll()source public статический

buildAll( )

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

Возвращает

массив

clear()source public статический

clear( )

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

getBaseType()source public

getBaseType( )

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

Возвращает

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

Реализация

Cake\Database\TypeInterface::getBaseType()

getMap()source public статический

getMap( string|null $type = null )

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

Параметры

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

Возвращает

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

С

3.6.2

getName()source public

getName( )

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

Возвращает

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

Реализация

Cake\Database\TypeInterface::getName()

map()source public статический

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 экземпляра устарело, используйте только строку имени класса. - Использование этого метода в качестве getter устарело. Используйте Type::getMap() вместо этого.

Параметры

строка|строка[]|Cake\Database\Type[]|null $type необязательно null
Если строковое имя типа для сопоставления, если массив списков массивов для сопоставления
строка|Cake\Database\Type|null $className необязательно null
Имя класса или экземпляр объекта для регистрации.

Возвращает

массив|строка|null

Если $type равен null, то массив с текущим отображением, если $className равен null, строка настроенного имени класса для заданного $type, в противном случае null


newId()source public

newId( )

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

Возвращает

смешанное
Новое значение первичного ключа.

Реализация

Cake\Database\TypeInterface::newId()

set()source public статический

set( string $name , Cake\Database\Type $instance )

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

Параметры

строка $name
Идентификатор типа, который нужно установить.
Cake\Database\Type $instance
Экземпляр типа, который нужно установить.

setMap()source public статический

setMap( array $map )

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

Параметры

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

С

3.6.2

strval()source public статический устарело

strval( mixed $value )

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

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

Устарело

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

Параметры

смешанное $value
Значение, которое нужно преобразовать в строку.

Возвращает

строка

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

$_formatsource

protected строка|массив

Формат даты для объекта DateTime

'Y-m-d'

$dateTimeClasssource

public статический строка

Класс для представления объектов даты

Это свойство можно использовать только до того, как будет создан экземпляр этого класса типа. После этого используйте useMutable() или useImmutable() вместо этого.

Устарело

3.2.0 Используйте DateType::useMutable() или DateType::useImmutable() вместо этого.
'Cake\I18n\Date'

$setToDateStartsource

protected логическое

В этом классе мы хотим, чтобы у объектов Date время было установлено в начало дня.

true

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

Spec-Zone.ru

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