Spec-Zone.ru › CakePHP 3.1

Класс TimeType

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

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

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

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

_parseValueисходный код protected

_parseValue( string $value )

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

Параметры

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

Возвращает

Cake\I18n\Time|null
\Cake\I18n\Time|null

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

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

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

__constructисходный код public

__construct( string $name null )

Конструктор

Параметры

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

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

Cake\Database\Type::__construct()

marshalисходный код public

marshal( mixed $value )

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

Параметры

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

Возвращает

Cake\I18n\Time|DateTime
\Cake\I18n\Time|\DateTime

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

Cake\Database\Type::marshal()

setLocaleFormatисходный код public

setLocaleFormat( string|array $format )

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

Параметры

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

Возвращает

mixed
$this

См. также

Cake\I18n\Time::parseDateTime()

toDatabaseисходный код public

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

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

Параметры

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

Возвращает

string
строка

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

Cake\Database\Type::toDatabase()

toPHPисходный код public

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

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

Параметры

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

Возвращает

Cake\I18n\Time|DateTime
\Cake\I18n\Time|\DateTime

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

Cake\Database\Type::toPHP()

useLocaleParserисходный код public

useLocaleParser( boolean $enable true )

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

Параметры

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

Возвращает

mixed
$this

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

_basicTypeCastисходный код protected

_basicTypeCast( mixed $value )

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

Устарело

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

Параметры

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

Возвращает

mixed
смешанный

boolvalисходный код public static

boolval( mixed $value )

Конвертер типа для булевых значений.

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

Устарело

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

Параметры

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

Возвращает

boolean
bool

buildисходный код public static

build( string $name )

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

Параметры

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

Возвращает

Cake\Database\Type
Type

Исключения

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

clearисходный код public static

clear( )

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

getBaseTypeисходный код public

getBaseType( )

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

Возвращает

string
строка

getNameисходный код public

getName( )

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

Возвращает

string
строка

mapисходный код public static

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

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

Параметры

строка|массив|Cake\Database\Type|null $type необязательно null
если строка - имя типа для сопоставления, если массив - список массивов для сопоставления
строка|null $className необязательно null
Класс для регистрации.

Возвращает

array|string|null
если $type равен null, то массив с текущим сопоставлением, если $className равен null, то строка с настроенным именем класса для данного $type, иначе null

newIdисходный код public

newId( )

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

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

Возвращает

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

См. также

Cake\Database\Type\UuidType

setисходный код public static

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

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

Параметры

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

strvalsource public static

strval( mixed $value )

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

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

Устаревший

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

Параметры

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

Возвращает

boolean
bool

toStatementsource public

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

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

Параметры

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

Возвращает

mixed
mixed

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

$_formatsource

protected string

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

'H:i:s'

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

$_datetimeInstancesource

protected DateTime

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

$_localeFormatsource

protected string|array|integer

Формат даты, используемый для разбора входящих дат для маршалинга.

$_useLocaleParsersource

protected boolean

Использовать ли локально-зависимый анализатор дат при разборе строковых входных данных для маршалинга.

false

$dateTimeClasssource

public static string

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

'Cake\I18n\Time'

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

$_basicTypessource

protected static array

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

Устаревший

3.1 Все типы теперь будут использовать определенный класс
[
    'string' => ['callback' => ['\Cake\Database\Type', 'strval']],
    'text' => ['callback' => ['\Cake\Database\Type', 'strval']],
    'boolean' => [
        'callback' => ['\Cake\Database\Type', 'boolval'],
        'pdo' => PDO::PARAM_BOOL
    ],
]

$_builtTypessource

protected static array

Содержит карту экземпляров объектов типов для повторного использования при необходимости

[]

$_namesource

protected string

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

null

$_typessource

protected static array

Список поддерживаемых типов баз данных. В качестве ключа используется удобочитаемый идентификатор, а в качестве значения — полное имя пространства имен класса, представляющее класс, который будет выполнять фактические преобразования типов.

[
    'biginteger' => 'Cake\Database\Type\IntegerType',
    'binary' => 'Cake\Database\Type\BinaryType',
    'boolean' => 'Cake\Database\Type\BoolType',
    'date' => 'Cake\Database\Type\DateType',
    'datetime' => 'Cake\Database\Type\DateTimeType',
    'decimal' => 'Cake\Database\Type\FloatType',
    'float' => 'Cake\Database\Type\FloatType',
    'integer' => 'Cake\Database\Type\IntegerType',
    'string' => 'Cake\Database\Type\StringType',
    'text' => 'Cake\Database\Type\StringType',
    'time' => 'Cake\Database\Type\TimeType',
    'timestamp' => 'Cake\Database\Type\DateTimeType',
    'uuid' => 'Cake\Database\Type\UuidType',
]

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

Spec-Zone.ru

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