Class TimeType

Time type converter.

Use to convert time instances to strings & back.

Cake\Database\Type
Extended by Cake\Database\Type\DateTimeType
Extended by Cake\Database\Type\TimeType

Method Detail

_parseValuesource 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|null
\Cake\I18n\Time|null

Overrides

Cake\Database\Type\DateTimeType::_parseValue()

Methods inherited from Cake\Database\Type\DateTimeType

__constructsource public

__construct( string $name null )

Constructor

Parameters

string $name optional null
The name identifying this type

Overrides

Cake\Database\Type::__construct()

marshalsource public

marshal( mixed $value )

Convert request data into a datetime object.

Parameters

mixed $value
Request data

Returns

Cake\I18n\Time|DateTime
\Cake\I18n\Time|\DateTime

Overrides

Cake\Database\Type::marshal()

setLocaleFormatsource 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

mixed
$this

See

Cake\I18n\Time::parseDateTime()

toDatabasesource 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

string
string

Overrides

Cake\Database\Type::toDatabase()

toPHPsource public

toPHP( string $value , Cake\Database\Driver $driver )

Convert strings into DateTime instances.

Parameters

string $value
The value to convert.
Cake\Database\Driver $driver
The driver instance to convert with.

Returns

Cake\I18n\Time|DateTime
\Cake\I18n\Time|\DateTime

Overrides

Cake\Database\Type::toPHP()

useLocaleParsersource 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

mixed
$this

Methods inherited from Cake\Database\Type

_basicTypeCastsource protected

_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

3.1 All types should now be a specific class

Parameters

mixed $value
value to be converted to PHP equivalent

Returns

mixed
mixed

boolvalsource public static

boolval( mixed $value )

Type converter for boolean values.

Will convert string true/false into booleans.

Deprecated

3.1.8 This method is now unused.

Parameters

mixed $value
The value to convert to a boolean.

Returns

boolean
bool

buildsource public static

build( string $name )

Returns a Type object capable of converting a type identified by $name

Parameters

string $name
type identifier

Returns

Cake\Database\Type
Type

Throws

InvalidArgumentException
If type identifier is unknown

clearsource public static

clear( )

Clears out all created instances and mapped types classes, useful for testing

getBaseTypesource 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

string
string

getNamesource public

getName( )

Returns type identifier name for this object

Returns

string
string

mapsource 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

array|string|null
if $type is null then array with current map, if $className is null string configured class name for give $type, null otherwise

newIdsource 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

mixed
A new primary key value.

See

Cake\Database\Type\UuidType

setsource 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.

strvalsource public static

strval( mixed $value )

Type converter for string values.

Will convert values into strings

Deprecated

3.1.8 This method is now unused.

Parameters

mixed $value
The value to convert to a string.

Returns

boolean
bool

toStatementsource 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

Returns

mixed
mixed

Properties summary

$_formatsource

protected string

Time format for DateTime object

'H:i:s'

Properties inherited from Cake\Database\Type\DateTimeType

$_datetimeInstancesource

protected DateTime

An instance of the configured dateTimeClass, used to quickly generate new instances without calling the constructor.

$_localeFormatsource

protected string|array|integer

The date format to use for parsing incoming dates for marshalling.

$_useLocaleParsersource

protected boolean

Whether dates should be parsed using a locale aware parser when marshalling string inputs.

false

$dateTimeClasssource

public static string

The class to use for representing date objects

'Cake\I18n\Time'

Properties inherited from Cake\Database\Type

$_basicTypessource

protected static array

List of basic type mappings, used to avoid having to instantiate a class for doing conversion on these

Deprecated

3.1 All types will now use a specific class
[
    'string' => ['callback' => ['\Cake\Database\Type', 'strval']],
    'text' => ['callback' => ['\Cake\Database\Type', 'strval']],
    'boolean' => [
        'callback' => ['\Cake\Database\Type', 'boolval'],
        'pdo' => PDO::PARAM_BOOL
    ],
]

$_builtTypessource

protected static array

Contains a map of type object instances to be reused if needed

[]

$_namesource

protected string

Identifier name for this type

null

$_typessource

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