Class TimeType
Time type converter.
Use to convert time instances to strings & back.
Property Summary
-
$_className protected
class-string<Cake\Chronos\ChronosTime>The classname to use when creating objects.
-
$_format protected
stringThe PHP Time format used when converting to string.
-
$_localeMarshalFormat protected
string|int|nullThe locale-aware format
marshal()uses when_useLocaleParseris true. -
$_name protected
string|nullIdentifier name for this type
-
$_useLocaleMarshal protected
boolWhether
marshal()should use locale-aware parser with_localeMarshalFormat.
Method Summary
-
__construct() public
Constructor
-
_parseLocalTimeValue() protected
Converts a string into a Time object after parsing it using the locale aware parser with the format set by
setLocaleFormat(). -
_parseTimeValue() protected
Converts a string into a Time object
-
getBaseType() public
Returns the base type name that this class is inheriting.
-
getName() public
Returns type identifier name for this object.
-
getTimeClassName() public
Get the classname used for building objects.
-
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.
-
setLocaleFormat() public
Sets the locale-aware format used by
marshal()when parsing strings. -
toDatabase() public
Convert time data into the database time format.
-
toPHP() public
Convert time values to PHP time instances
-
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, class-string<Cake\Chronos\ChronosTime>|null $className = null)Constructor
Parameters
-
string|null$name optional The name identifying this type.
-
class-string<Cake\Chronos\ChronosTime>|null$className optional Class name for time representation.
_parseLocalTimeValue() ¶ protected
_parseLocalTimeValue(string $value): Cake\Chronos\ChronosTime|nullConverts a string into a Time 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\Chronos\ChronosTime|null_parseTimeValue() ¶ protected
_parseTimeValue(string $value): Cake\Chronos\ChronosTime|nullConverts a string into a Time object
Parameters
-
string$value The value to parse and convert to an object.
Returns
Cake\Chronos\ChronosTime|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|nullgetName() ¶ public
getName(): string|nullReturns type identifier name for this object.
Returns
string|nullgetTimeClassName() ¶ public
getTimeClassName(): class-string<Cake\Chronos\ChronosTime>Get the classname used for building objects.
Returns
class-string<Cake\Chronos\ChronosTime>manyToPHP() ¶ public
manyToPHP(array $values, list<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 -
list<string>$fields -
Cake\Database\Driver$driver
Returns
array<string, mixed>marshal() ¶ public
marshal(mixed $value): Cake\Chronos\ChronosTime|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
Cake\Chronos\ChronosTime|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
mixedsetLocaleFormat() ¶ public
setLocaleFormat(string|int|null $format): $thisSets the locale-aware format used by marshal() when parsing strings.
See Cake\I18n\Time::parseTime() for accepted formats.
Parameters
-
string|int|null$format The locale-aware format
Returns
$thisSee Also
toDatabase() ¶ public
toDatabase(mixed $value, Cake\Database\Driver $driver): mixedConvert time data into the database time format.
Parameters
-
mixed$value The value to convert.
-
Cake\Database\Driver$driver The driver instance to convert with.
Returns
mixedtoPHP() ¶ public
toPHP(mixed $value, Cake\Database\Driver $driver): Cake\Chronos\ChronosTime|nullConvert time values to PHP time instances
Parameters
-
mixed$value The value to convert.
-
Cake\Database\Driver$driver The driver instance to convert with.
Returns
Cake\Chronos\ChronosTime|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\Chronos\ChronosTime>$_localeMarshalFormat ¶ protected
The locale-aware format marshal() uses when _useLocaleParser is true.
See Cake\I18n\Time::parseTime() for accepted formats.
Type
string|int|null$_useLocaleMarshal ¶ protected
Whether marshal() should use locale-aware parser with _localeMarshalFormat.
Type
bool