Class DateType
Datetime type converter.
Use to convert datetime instances to strings & back.
- Cake\Database\Type
-
Cake\Database\Type\DateTimeType
-
Cake\Database\Type\DateType
Properties summary
-
$_formatprotectedstringDate format for DateTime object
Inherited Properties
Method Summary
-
_parseValue() protected
Converts a string into a DateTime object after parseing it using the locale aware parser with the specified format.
-
marshal() public
Convert request data into a datetime object. -
toPHP() public
Convert strings into Date instances.
Method Detail
_parseValue() protected ¶
_parseValue( string $value )
Converts a string into a DateTime object after parseing it using the locale aware parser with the specified format.
Parameters
- string $value
- The value to parse and convert to an object.
Returns
Cake\I18n\Time|nullOverrides
marshal() public ¶
marshal( mixed $value )
Convert request data into a datetime object.
Parameters
- mixed $value
- Request data
Returns
Overrides
toPHP() public ¶
toPHP( string $value , Cake\Database\Driver $driver )
Convert strings into Date instances.
Parameters
- string $value
- The value to convert.
-
Cake\Database\Driver$driver - The driver instance to convert with.
Returns
Overrides
Methods inherited from Cake\Database\Type\DateTimeType
__construct() public ¶
__construct( string $name = null )
Constructor
Parameters
- string $name optional null
- The name identifying this type
Overrides
setLocaleFormat() public ¶
setLocaleFormat( string|array $format )
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.
Parameters
- string|array $format
- The format in which the string are passed.
Returns
$this
See
toDatabase() public ¶
toDatabase( string|integer|DateTime $value , Cake\Database\Driver $driver )
Convert DateTime instance into strings.
Parameters
- string|integer|DateTime $value
- The value to convert.
-
Cake\Database\Driver$driver - The driver instance to convert with.
Returns
Overrides
useLocaleParser() public ¶
useLocaleParser( boolean $enable = true )
Sets whether or not to parse dates passed to the marshal() function by using a locale aware parser.
Parameters
- boolean $enable optional true
- Whether or not to enable
Returns
$this
Methods inherited from Cake\Database\Type
_basicTypeCast() protected deprecated ¶
_basicTypeCast( mixed $value )
Checks whether this type is a basic one and can be converted using a callback If it is, returns converted value
Deprecated
Parameters
- mixed $value
- value to be converted to PHP equivalent
Returns
boolval() public static deprecated ¶
boolval( mixed $value )
Type converter for boolean values.
Will convert string true/false into booleans.
Deprecated
Parameters
- mixed $value
- The value to convert to a boolean.
Returns
build() public static ¶
build( string $name )
Returns a Type object capable of converting a type identified by $name
Parameters
- string $name
- type identifier
Returns
Throws
If type identifier is unknown
clear() public static ¶
clear( )
Clears out all created instances and mapped types classes, useful for testing
getBaseType() public ¶
getBaseType( )
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.
Returns
map() public static ¶
map( string|array|Cake\Database\Type|null $type = null , string|null $className = 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
Parameters
-
string|array|
Cake\Database\Type|null $type optional null - if string name of type to map, if array list of arrays to be mapped
- string|null $className optional null
- The classname to register.
Returns
if $type is null then array with current map, if $className is null string configured class name for give $type, null otherwise
newId() public ¶
newId( )
Generate 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
A new primary key value.
See
set() public static ¶
set( string $name , Cake\Database\Type $instance )
Returns a Type object capable of converting a type identified by $name
Parameters
- string $name
- The type identifier you want to set.
-
Cake\Database\Type$instance - The type instance you want to set.
strval() public static deprecated ¶
strval( mixed $value )
Type converter for string values.
Will convert values into strings
Deprecated
Parameters
- mixed $value
- The value to convert to a string.
Returns
toStatement() public ¶
toStatement( mixed $value , Cake\Database\Driver $driver )
Casts give value to Statement 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