Time type converter.
Use to convert time instances to strings & back.
_parseValue( string $value )
Converts a string into a DateTime object after parseing it using the locale aware parser with the specified format.
$value
Cake\I18n\Time|null
Cake\Database\Type\DateTimeType::_parseValue()
__construct( string $name null )
Constructor
$name
optional null Cake\Database\Type::__construct()
marshal( mixed $value )
Convert request data into a datetime object.
$value
Cake\I18n\Time|DateTime
Cake\Database\Type::marshal()
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.
$format
mixed
Cake\I18n\Time::parseDateTime()
toDatabase( string|integer|DateTime $value , Cake\Database\Driver $driver )
Convert DateTime instance into strings.
$value
Cake\Database\Driver
$driver
string
Cake\Database\Type::toDatabase()
toPHP( string $value , Cake\Database\Driver $driver )
Convert strings into DateTime instances.
$value
Cake\Database\Driver
$driver
Cake\I18n\Time|DateTime
Cake\Database\Type::toPHP()
useLocaleParser( boolean $enable true )
Sets whether or not to parse dates passed to the marshal() function by using a locale aware parser.
$enable
optional true mixed
_basicTypeCast( mixed $value )
Checks whether this type is a basic one and can be converted using a callback If it is, returns converted value
$value
mixed
boolval( mixed $value )
Type converter for boolean values.
Will convert string true/false into booleans.
$value
boolean
build( string $name )
Returns a Type object capable of converting a type identified by $name
$name
Cake\Database\Type
InvalidArgumentException
clear( )
Clears out all created instances and mapped types classes, useful for testing
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.
string
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
Cake\Database\Type
|null $type
optional null $className
optional null array|string|null
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.
mixed
Cake\Database\Type\UuidType
set( string $name , Cake\Database\Type $instance )
Returns a Type object capable of converting a type identified by $name
$name
Cake\Database\Type
$instance
strval( mixed $value )
Type converter for string values.
Will convert values into strings
$value
boolean
toStatement( mixed $value , Cake\Database\Driver $driver )
Casts give value to Statement equivalent
$value
Cake\Database\Driver
$driver
mixed
protected DateTime
An instance of the configured dateTimeClass, used to quickly generate new instances without calling the constructor.
protected string|array|integer
The date format to use for parsing incoming dates for marshalling.
protected boolean
Whether dates should be parsed using a locale aware parser when marshalling string inputs.
false
public static string
The class to use for representing date objects
'Cake\I18n\Time'
protected static array
List of basic type mappings, used to avoid having to instantiate a class for doing conversion on these
[ 'string' => ['callback' => ['\Cake\Database\Type', 'strval']], 'text' => ['callback' => ['\Cake\Database\Type', 'strval']], 'boolean' => [ 'callback' => ['\Cake\Database\Type', 'boolval'], 'pdo' => PDO::PARAM_BOOL ], ]
protected static array
Contains a map of type object instances to be reused if needed
[]
protected static array
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.
[ 'biginteger' => 'Cake\Database\Type\IntegerType', 'binary' => 'Cake\Database\Type\BinaryType', 'boolean' => 'Cake\Database\Type\BoolType', 'date' => 'Cake\Database\Type\DateType', 'datetime' => 'Cake\Database\Type\DateTimeType', 'decimal' => 'Cake\Database\Type\FloatType', 'float' => 'Cake\Database\Type\FloatType', 'integer' => 'Cake\Database\Type\IntegerType', 'string' => 'Cake\Database\Type\StringType', 'text' => 'Cake\Database\Type\StringType', 'time' => 'Cake\Database\Type\TimeType', 'timestamp' => 'Cake\Database\Type\DateTimeType', 'uuid' => 'Cake\Database\Type\UuidType', ]
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Database.Type.TimeType.html