Spec-Zone.ru › CakePHP 3.2

Класс DateType

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

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

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

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

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

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

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

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

  • _parseValue() protected

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

  • marshal() public
    Преобразование данных запроса в объект datetime.
  • toPHP() public
    Преобразование строк в экземпляры Date.
  • 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
Данные запроса

Возвращает

DateTime

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

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

toPHP()source public

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

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

Параметры

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

Возвращает

Cake\I18n\Date|DateTime

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

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

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()

_setClassName()source protected

_setClassName( string $class , string $fallback )

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

Параметры

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

setLocaleFormat()source public

setLocaleFormat( string|array $format )

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

Параметры

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

Возвращает


$this

См.

\Cake\I18n\Time::parseDateTime()

toDatabase()source public

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

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

Параметры

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

Возвращает

строка

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

Cake\Database\Type::toDatabase()

Реализация

Cake\Database\TypeInterface::toDatabase()

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

_basicTypeCast()source protected

_basicTypeCast( mixed $value )

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

Устарело

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

Параметры

смешанное $value
значение для преобразования в PHP эквивалент

Возвращает

смешанное

boolval()source public static

boolval( mixed $value )

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

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

Устарело

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

Параметры

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

Возвращает

логическое

build()source public static

build( string $name )

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

Параметры

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

Возвращает

Cake\Database\Type

Исключения

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

buildAll()source public static

buildAll( )

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

Возвращает

array

clear()source public static

clear( )

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

getBaseType()source public

getBaseType( )

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

Возвращает

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

Реализация

Cake\Database\TypeInterface::getBaseType()

getName()source public

getName( )

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

Возвращает

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

Реализация

Cake\Database\TypeInterface::getName()

map()source public static

map( string|array|Cake\Database\Type|null $type null , string|null $className null )

Регистрирует новый идентификатор типа и сопоставляет его с полным именем класса с пространством имен. Если вызвана без аргументов, вернёт текущий массив сопоставлений. Если $className опущен, вернёт сопоставленный класс для $type.

Параметры

string|array|Cake\Database\Type|null $type необязательно null
если строка — имя типа для сопоставления, если массив — список массивов для сопоставления
string|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 )

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

Параметры

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

strval()source public static

strval( mixed $value )

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

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

Устарело

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

Параметры

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

Возвращает

boolean

Подробности свойств

$_formatsource

protected string

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

'Y-m-d'

$dateTimeClasssource

public static string

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

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

Устарело

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

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

Spec-Zone.ru

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