$dateTimeClass
$dateTimeClass : string
The class to use for representing date objects
This property can only be used before an instance of this type
class is constructed. After that use useMutable() or useImmutable() instead.
Class DateType
Use to convert datetime instances to strings & back.
$_types : array<mixed,string>|array<mixed,\Cake\Database\Type>
List of supported database types. A human readable identifier is used as key and a complete namespaced class name as value representing the class that will do actual type conversions.
$_builtTypes : array<mixed,\Cake\Database\Type>
Contains a map of type object instances to be reused if needed.
toDatabase(mixed $value, \Cake\Database\Driver $driver) : mixed
Casts given value from a PHP type to one acceptable by a database.
| mixed | $value | Value to be converted to a database equivalent. |
| \Cake\Database\Driver | $driver | Object from which database preferences and configuration will be extracted. |
Given PHP type casted to one acceptable by a database.
setTimezone(string|\DateTimeZone|null $timezone) : $this
Set database timezone.
Specified timezone will be set for DateTime objects before generating
datetime string for saving to database. If null no timezone conversion
will be done.
| string|\DateTimeZone|null | $timezone | Database timezone. |
toPHP(mixed $value, \Cake\Database\Driver $driver) : mixed
Casts given value from a database type to PHP equivalent
| mixed | $value | Value to be converted to PHP equivalent |
| \Cake\Database\Driver | $driver | Object from which database preferences and configuration will be extracted |
manyToPHP(array $values, array $fields, \Cake\Database\Driver $driver) : array
Returns an array of the values converted to the PHP representation of this type.
| array | $values | The original array of values containing the fields to be casted |
| array | $fields | The field keys to cast |
| \Cake\Database\Driver | $driver | Object from which database preferences and configuration will be extracted. |
setLocaleFormat(string|array $format) : $this
Sets the format string to use for parsing dates in this class. The formats that are accepted are documented in the `Cake\I18n\Time::parseDateTime()` function.
| string|array | $format | The format in which the string are passed. |
toStatement(mixed $value, \Cake\Database\Driver $driver) : mixed
Casts given value to its Statement equivalent.
| mixed | $value | Value to be converted to PDO statement. |
| \Cake\Database\Driver | $driver | Object from which database preferences and configuration will be extracted. |
Given value casted to its Statement equivalent.
build(string $name) : \Cake\Database\Type
Returns a Type object capable of converting a type identified by name.
| string | $name | type identifier |
If type identifier is unknown
set(string $name, \Cake\Database\Type $instance) : void
Returns a Type object capable of converting a type identified by $name
| string | $name | The type identifier you want to set. |
| \Cake\Database\Type | $instance | The type instance you want to set. |
map(string|array<mixed,string>|array<mixed,\Cake\Database\Type>|null $type = null, string|\Cake\Database\Type|null $className = null) : array|string|null
Registers a new type identifier and maps it to a fully namespaced classname, If called with no arguments it will return current types map array If $className is omitted it will return mapped class for $type
Deprecated 3.6.2:
| string|array<mixed,string>|array<mixed,\Cake\Database\Type>|null | $type | If string name of type to map, if array list of arrays to be mapped |
| string|\Cake\Database\Type|null | $className | The classname or object instance of it to register. |
If $type is null then array with current map, if $className is null string configured class name for give $type, null otherwise
getMap(string|null $type = null) : array|string|\Cake\Database\TypeInterface|null
Get mapped class name or instance for type(s).
| string|null | $type | Type name to get mapped class for or null to get map array. |
Configured class name or instance for give $type or map array.
getBaseType() : string
Returns 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.
The base type name that this class is inheriting.
_compare(\Cake\I18n\Time|\DateTime $date, mixed $value) : boolean
| \Cake\I18n\Time|\DateTime | $date | DateTime object |
| mixed | $value | Request data |
_parseValue(string $value) : \Cake\I18n\Time|null
Converts a string into a DateTime object after parsing it using the locale aware parser with the specified format.
| string | $value | The value to parse and convert to an object. |