Class DateTimeType
Datetime type converter.
Use to convert datetime instances to strings & back.
Property Summary
-
$_className protected
class-string<Cake\I18n\DateTime>|class-string<DateTimeImmutable>The classname to use when creating objects.
-
$_format protected
stringThe DateTime format used when converting to string.
-
$_localeMarshalFormat protected
array|string|int|nullThe locale-aware format
marshal()uses when_useLocaleParseris true. -
$_marshalFormats protected
list<string>The DateTime formats allowed by
marshal(). -
$_name protected
string|nullIdentifier name for this type
-
$_useLocaleMarshal protected
boolWhether
marshal()should use locale-aware parser with_localeMarshalFormat. -
$dbTimezone protected
DateTimeZone|nullDatabase time zone.
-
$defaultTimezone protected
DateTimeZoneDefault time zone.
-
$keepDatabaseTimezone protected
boolWhether database time zone is kept when converting
-
$userTimezone protected
DateTimeZone|nullUser time zone.
Method Summary
-
__construct() public
Constructor
-
_parseLocaleValue() protected
Converts a string into a DateTime object after parsing it using the locale aware parser with the format set by
setLocaleFormat(). -
_parseValue() protected
Converts a string into a DateTime object after parsing it using the formats in
_marshalFormats. -
getBaseType() public
Returns the base type name that this class is inheriting.
-
getDateTimeClassName() public
Get the classname used for building objects.
-
getName() public
Returns type identifier name for this object.
-
manyToPHP() public
Returns an array of the values converted to the PHP representation of this type.
-
marshal() public
Convert request data into a datetime object.
-
newId() public
Generate a new primary key value for a given type.
-
setDatabaseTimezone() public
Set database timezone.
-
setKeepDatabaseTimezone() public
Set whether DateTime object created from database string is converted to default time zone.
-
setLocaleFormat() public
Sets the locale-aware format used by
marshal()when parsing strings. -
setUserTimezone() public
Set user timezone.
-
toDatabase() public
Convert DateTime instance into strings.
-
toPHP() public
Casts given value from a database type to a PHP equivalent.
-
toStatement() public
Get the binding type to use in a PDO statement.
-
useLocaleParser() public
Sets whether to parse strings passed to
marshal()using the locale-aware format set bysetLocaleFormat().
Method Detail
__construct() ¶ public
__construct(string|null $name = null)Constructor
Parameters
-
string|null$name optional The name identifying this type
_parseLocaleValue() ¶ protected
_parseLocaleValue(string $value): Cake\I18n\DateTime|nullConverts a string into a DateTime object after parsing it using the locale
aware parser with the format set by setLocaleFormat().
Parameters
-
string$value The value to parse and convert to an object.
Returns
Cake\I18n\DateTime|null_parseValue() ¶ protected
_parseValue(string $value): Cake\I18n\DateTime|DateTimeImmutable|nullConverts a string into a DateTime object after parsing it using the
formats in _marshalFormats.
Parameters
-
string$value The value to parse and convert to an object.
Returns
Cake\I18n\DateTime|DateTimeImmutable|nullgetBaseType() ¶ public
getBaseType(): string|nullReturns the base type name that this class is inheriting.
This is useful when extending base type for adding extra functionality, but still want the rest of the framework to use the same assumptions it would do about the base type it inherits from.
Returns
string|nullgetDateTimeClassName() ¶ public
getDateTimeClassName(): class-string<Cake\I18n\DateTime>|class-string<DateTimeImmutable>Get the classname used for building objects.
Returns
class-string<Cake\I18n\DateTime>|class-string<DateTimeImmutable>getName() ¶ public
getName(): string|nullReturns type identifier name for this object.
Returns
string|nullmanyToPHP() ¶ public
manyToPHP(array $values, array<string> $fields, Cake\Database\Driver $driver): array<string, mixed>Returns an array of the values converted to the PHP representation of this type.
Parameters
-
array$values -
array<string>$fields -
Cake\Database\Driver$driver
Returns
array<string, mixed>marshal() ¶ public
marshal(mixed $value): DateTimeInterface|nullConvert request data into a datetime object.
Most useful for converting request data into PHP objects, that make sense for the rest of the ORM/Database layers.
Parameters
-
mixed$value Request data
Returns
DateTimeInterface|nullnewId() ¶ public
newId(): mixedGenerate a new primary key value for a given type.
This method can be used by types to create new primary key values when entities are inserted.
Returns
mixedsetDatabaseTimezone() ¶ public
setDatabaseTimezone(DateTimeZone|string|null $timezone): $thisSet database timezone.
This is the time zone used when converting database strings to DateTime instances and converting DateTime instances to database strings.
Parameters
-
DateTimeZone|string|null$timezone Database timezone.
Returns
$thisSee Also
setKeepDatabaseTimezone() ¶ public
setKeepDatabaseTimezone(bool $keep): $thisSet whether DateTime object created from database string is converted to default time zone.
If your database date times are in a specific time zone that you want to keep in the DateTime instance then set this to true.
When false, datetime timezones are converted to default time zone. This is default behavior.
Parameters
-
bool$keep If true, database time zone is kept when converting to DateTime instances.
Returns
$thissetLocaleFormat() ¶ public
setLocaleFormat(array|string $format): $thisSets the locale-aware format used by marshal() when parsing strings.
See Cake\I18n\Time::parseDateTime() for accepted formats.
Parameters
-
array|string$format The locale-aware format
Returns
$thisSee Also
setUserTimezone() ¶ public
setUserTimezone(DateTimeZone|string|null $timezone): $thisSet user timezone.
This is the time zone used when marshalling strings to DateTime instances.
Parameters
-
DateTimeZone|string|null$timezone User timezone.
Returns
$thistoDatabase() ¶ public
toDatabase(mixed $value, Cake\Database\Driver $driver): string|nullConvert DateTime instance into strings.
Parameters
-
mixed$value The value to convert.
-
Cake\Database\Driver$driver The driver instance to convert with.
Returns
string|nulltoPHP() ¶ public
toPHP(mixed $value, Cake\Database\Driver $driver): Cake\I18n\DateTime|DateTimeImmutable|nullCasts given value from a database type to a PHP equivalent.
Parameters
-
mixed$value Value to be converted to PHP equivalent
-
Cake\Database\Driver$driver Object from which database preferences and configuration will be extracted
Returns
Cake\I18n\DateTime|DateTimeImmutable|nulltoStatement() ¶ public
toStatement(mixed $value, Cake\Database\Driver $driver): intGet the binding type to use in a PDO statement.
Parameters
-
mixed$value -
Cake\Database\Driver$driver
Returns
intuseLocaleParser() ¶ public
useLocaleParser(bool $enable = true): $thisSets whether to parse strings passed to marshal() using
the locale-aware format set by setLocaleFormat().
Parameters
-
bool$enable optional Whether to enable
Returns
$thisProperty Detail
$_className ¶ protected
The classname to use when creating objects.
Type
class-string<Cake\I18n\DateTime>|class-string<DateTimeImmutable>$_localeMarshalFormat ¶ protected
The locale-aware format marshal() uses when _useLocaleParser is true.
See Cake\I18n\Time::parseDateTime() for accepted formats.
Type
array|string|int|null$_useLocaleMarshal ¶ protected
Whether marshal() should use locale-aware parser with _localeMarshalFormat.
Type
bool