类 TimeType

时间类型转换器。

用于将时间实例转换为字符串和反之。

命名空间： Cake\Database\Type

属性摘要

$_className protected

class-stringCake\Chronos\ChronosTime>

创建对象时使用的类名。
$_format protected

string

转换为字符串时使用的 PHP 时间格式。
$_localeMarshalFormat protected

string|int|null

当 _useLocaleParser 为 true 时，marshal() 使用的本地化格式。
$_name protected

string|null

此类型的标识符名称
$_useLocaleMarshal protected

bool

marshal() 是否应使用 _localeMarshalFormat 的本地化解析器。

方法摘要

__construct() public

构造函数
_parseLocalTimeValue() protected

使用 setLocaleFormat() 设置的格式，使用本地化解析器解析字符串后，将字符串转换为 Time 对象。
_parseTimeValue() protected

将字符串转换为 Time 对象
getBaseType() public

返回此类继承的基类型名称。
getName() public

返回此对象的类型标识符名称。
getTimeClassName() public

获取用于构建对象的类名。
manyToPHP() public

返回将值转换为此类型的 PHP 表示形式的数组。
marshal() public

将请求数据转换为日期时间对象。
newId() public

为给定类型生成新的主键值。
setLocaleFormat() public

设置 marshal() 解析字符串时使用的本地化格式。
toDatabase() public

将时间数据转换为数据库时间格式。
toPHP() public

将时间值转换为 PHP 时间实例
toStatement() public

获取要在 PDO 语句中使用的绑定类型。
useLocaleParser() public

设置是否使用 setLocaleFormat() 设置的本地化格式解析传递给 marshal() 的字符串。

方法详情

__construct() ¶ public

__construct(string|null $name = null, class-stringCake\Chronos\ChronosTime>|null $className = null)

构造函数

参数

string|null $name 可选: 标识此类型的名称。
class-stringCake\Chronos\ChronosTime>|null $className 可选: 时间表示的类名。

_parseLocalTimeValue() ¶ protected

_parseLocalTimeValue(string $value): Cake\Chronos\ChronosTime|null

使用 setLocaleFormat() 设置的格式，使用本地化解析器解析字符串后，将字符串转换为 Time 对象。

参数

string $value: 要解析并转换为对象的 value。

返回值

Cake\Chronos\ChronosTime|null

_parseTimeValue() ¶ protected

_parseTimeValue(string $value): Cake\Chronos\ChronosTime|null

将字符串转换为 Time 对象

参数

string $value: 要解析并转换为对象的 value。

返回值

Cake\Chronos\ChronosTime|null

getBaseType() ¶ public

getBaseType(): string|null

返回此类继承的基类型名称。

这在扩展基类型以添加额外功能时很有用，但仍希望框架的其余部分使用它对继承的基类型所做的相同假设。

返回值

string|null

getName() ¶ public

getName(): string|null

返回此对象的类型标识符名称。

返回值

string|null

getTimeClassName() ¶ public

getTimeClassName(): class-stringCake\Chronos\ChronosTime>

获取用于构建对象的类名。

返回值

class-stringCake\Chronos\ChronosTime>

manyToPHP() ¶ public

manyToPHP(array $values, list<string> $fields, Cake\Database\Driver $driver): array<string, mixed>

返回将值转换为此类型的 PHP 表示形式的数组。

参数

array $values
list<string> $fields
Cake\Database\Driver $driver

返回值

array<string, mixed>

marshal() ¶ public

marshal(mixed $value): Cake\Chronos\ChronosTime|null

将请求数据转换为日期时间对象。

最适合将请求数据转换为 PHP 对象，这对于 ORM/数据库层的其余部分来说是有意义的。

参数

mixed $value: 请求数据

返回值

Cake\Chronos\ChronosTime|null

newId() ¶ public

newId(): mixed

为给定类型生成新的主键值。

此方法可由类型在插入实体时创建新的主键值。

返回值

mixed

setLocaleFormat() ¶ public

setLocaleFormat(string|int|null $format): $this

设置 marshal() 解析字符串时使用的本地化格式。

有关接受的格式，请参阅 Cake\I18n\Time::parseTime()。

参数

string|int|null $format: 本地化格式

返回值

$this

另请参阅

\Cake\I18n\Time::parseTime()

toDatabase() ¶ public

toDatabase(mixed $value, Cake\Database\Driver $driver): mixed

将时间数据转换为数据库时间格式。

参数

mixed $value: 要转换的值。
Cake\Database\Driver $driver: 要转换的驱动程序实例。

返回值

mixed

toPHP() ¶ public

toPHP(mixed $value, Cake\Database\Driver $driver): Cake\Chronos\ChronosTime|null

将时间值转换为 PHP 时间实例

参数

mixed $value: 要转换的值。
Cake\Database\Driver $driver: 要转换的驱动程序实例。

返回值

Cake\Chronos\ChronosTime|null

toStatement() ¶ public

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

获取要在 PDO 语句中使用的绑定类型。

参数

mixed $value
Cake\Database\Driver $driver

返回值

int

useLocaleParser() ¶ public

useLocaleParser(bool $enable = true): $this

设置是否使用 setLocaleFormat() 设置的本地化格式解析传递给 marshal() 的字符串。

参数

bool $enable 可选: 是否启用

返回值

$this

属性详情

`$_className` ¶ protected

创建对象时使用的类名。

Type

class-stringCake\Chronos\ChronosTime>

`$_format` ¶ protected

转换为字符串时使用的 PHP 时间格式。

Type

string

`$_localeMarshalFormat` ¶ 受保护

当 _useLocaleParser 为 true 时，marshal() 使用的本地化格式。

有关接受的格式，请参阅 Cake\I18n\Time::parseTime()。

Type

string|int|null

`$_name` ¶ 受保护

此类型的标识符名称

Type

string|null

`$_useLocaleMarshal` ¶ 受保护

marshal() 是否应使用 _localeMarshalFormat 的本地化解析器。

Type

bool

命名空间

类 TimeType

属性摘要

方法摘要

__construct() public

_parseLocalTimeValue() protected

_parseTimeValue() protected

getBaseType() public

getName() public

getTimeClassName() public

manyToPHP() public

marshal() public

newId() public

setLocaleFormat() public

toDatabase() public

toPHP() public

toStatement() public

useLocaleParser() public

方法详情

__construct() ¶ public

参数

_parseLocalTimeValue() ¶ protected

参数

返回值

_parseTimeValue() ¶ protected

参数

返回值

getBaseType() ¶ public

返回值

getName() ¶ public

返回值

getTimeClassName() ¶ public

返回值

manyToPHP() ¶ public

参数

返回值

marshal() ¶ public

参数

返回值

newId() ¶ public

返回值

setLocaleFormat() ¶ public

参数

返回值

另请参阅

toDatabase() ¶ public

参数

返回值

toPHP() ¶ public

参数

返回值

toStatement() ¶ public

参数

返回值

useLocaleParser() ¶ public

参数

返回值

属性详情

$_className ¶ protected

Type

$_format ¶ protected

Type

$_localeMarshalFormat ¶ 受保护

Type

$_name ¶ 受保护

Type

$_useLocaleMarshal ¶ 受保护

Type

`$_className` ¶ protected

`$_format` ¶ protected

`$_localeMarshalFormat` ¶ 受保护

`$_name` ¶ 受保护

`$_useLocaleMarshal` ¶ 受保护