类 DateType
类 DateType
属性概览
-
$_className protected
class-stringCake\Chronos\ChronosDate>
创建对象时使用的类名。
-
$_format protected
string
-
$_localeMarshalFormat protected
string|int|null
当
_useLocaleParser
为 true 时,marshal()
使用的区域感知格式。 -
$_marshalFormats protected
list<string>
-
$_name protected
string|null
此类型的标识符名称
-
$_useLocaleMarshal protected
bool
marshal()
是否应该使用区域感知解析器和_localeMarshalFormat
。
方法概览
-
__construct() public
构造函数
-
_parseLocaleValue() protected
-
_parseValue() protected
使用
_marshalFormats
中的格式解析字符串后,将字符串转换为 DateTime 对象。 -
getBaseType() public
返回此类继承的基类型名称。
-
getDateClassName() public
获取用于构建对象的类名。
-
getName() public
返回此对象的类型标识符名称。
-
manyToPHP() public
返回将值转换为此类型的 PHP 表示形式的数组。
-
marshal() public
将请求数据转换为日期时间对象。
-
newId() public
为给定类型生成新的主键值。
-
setLocaleFormat() public
设置解析字符串时
marshal()
使用的区域感知格式。 -
toDatabase() public
将 DateTime 实例转换为字符串。
-
toPHP() public
将给定值从数据库类型转换为 PHP 等效类型。
-
toStatement() public
获取要在 PDO 语句中使用的绑定类型。
-
useLocaleParser() public
设置是否使用
setLocaleFormat()
设置的区域感知格式解析传递给marshal()
的字符串。
方法详情
_parseLocaleValue() ¶ protected
_parseLocaleValue(string $value): Cake\I18n\Date|null
参数
-
string
$value
返回
Cake\I18n\Date|null
_parseValue() ¶ protected
_parseValue(string $value): Cake\Chronos\ChronosDate|null
使用 _marshalFormats
中的格式解析字符串后,将字符串转换为 DateTime 对象。
参数
-
string
$value 要解析并转换为对象的值。
返回
Cake\Chronos\ChronosDate|null
getBaseType() ¶ public
getBaseType(): string|null
返回此类继承的基类型名称。
这在扩展基类型以添加额外功能时很有用,但仍希望框架的其他部分使用与继承的基类型相同的假设。
返回
string|null
getDateClassName() ¶ public
getDateClassName(): class-stringCake\Chronos\ChronosDate>
获取用于构建对象的类名。
返回
class-stringCake\Chronos\ChronosDate>
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\ChronosDate|null
将请求数据转换为日期时间对象。
最适合将请求数据转换为 PHP 对象,这些对象对 ORM/数据库层更有意义。
参数
-
mixed
$value 请求数据
返回
Cake\Chronos\ChronosDate|null
setLocaleFormat() ¶ public
setLocaleFormat(string|int $format): $this
设置解析字符串时 marshal()
使用的区域感知格式。
有关接受的格式,请参阅 Cake\I18n\Date::parseDate()
。
参数
-
string|int
$format 区域感知格式
返回
$this
另请参阅
toDatabase() ¶ public
toDatabase(mixed $value, Cake\Database\Driver $driver): string|null
将 DateTime 实例转换为字符串。
参数
-
mixed
$value 要转换的值。
-
Cake\Database\Driver
$driver 要转换的驱动程序实例。
返回
string|null
toPHP() ¶ public
toPHP(mixed $value, Cake\Database\Driver $driver): Cake\Chronos\ChronosDate|null
将给定值从数据库类型转换为 PHP 等效类型。
参数
-
mixed
$value 要转换为 PHP 等效类型的值
-
Cake\Database\Driver
$driver 将从中提取数据库首选项和配置的对象
返回
Cake\Chronos\ChronosDate|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
属性详情
$_localeMarshalFormat ¶ protected
当 _useLocaleParser
为 true 时,marshal()
使用的区域感知格式。
有关接受的格式,请参阅 Cake\I18n\Date::parseDate()
。
Type
string|int|null