CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Team
    • Issues (Github)
    • YouTube Channel
    • Get Involved
    • Bakery
    • Featured Resources
    • Newsletter
    • Certification
    • My CakePHP
    • CakeFest
    • Facebook
    • Twitter
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.1 Red Velvet API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 3.1
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Cake
    • Auth
      • Storage
    • Cache
      • Engine
    • Collection
      • Iterator
    • Console
      • Exception
    • Controller
      • Component
      • Exception
    • Core
      • Configure
        • Engine
      • Exception
    • Database
      • Driver
      • Exception
      • Expression
      • Schema
      • Statement
      • Type
    • Datasource
      • Exception
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
      • Formatter
      • Parser
    • Log
      • Engine
    • Mailer
      • Exception
      • Transport
    • Network
      • Exception
      • Http
        • Adapter
        • Auth
        • FormData
      • Session
    • ORM
      • Association
      • Behavior
        • Translate
      • Exception
      • Locator
      • Rule
    • Routing
      • Exception
      • Filter
      • Route
    • Shell
      • Helper
      • Task
    • TestSuite
      • Fixture
      • Stub
    • Utility
      • Exception
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget
  • None

Classes

  • BinaryType
  • BoolType
  • DateTimeType
  • DateType
  • FloatType
  • IntegerType
  • StringType
  • TimeType
  • UuidType

Class DateType

Datetime type converter.

Use to convert datetime instances to strings & back.

Cake\Database\Type
Extended by Cake\Database\Type\DateTimeType
Extended by Cake\Database\Type\DateType
Namespace: Cake\Database\Type
Location: Database/Type/DateType.php

Properties summary

  • $_format protected
    string
    Date format for DateTime object

Inherited Properties

  • _datetimeInstance, _localeFormat, _useLocaleParser, dateTimeClass _basicTypes, _builtTypes, _name, _types

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|null
Overrides
Cake\Database\Type\DateTimeType::_parseValue()

marshal() public ¶

marshal( mixed $value )

Convert request data into a datetime object.

Parameters
mixed $value
Request data
Returns
DateTime
Overrides
Cake\Database\Type\DateTimeType::marshal()

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
Carbon\Carbon
Overrides
Cake\Database\Type\DateTimeType::toPHP()

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
Cake\Database\Type::__construct()

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
\Cake\I18n\Time::parseDateTime()

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
string
Overrides
Cake\Database\Type::toDatabase()

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
3.1 All types should now be a specific class
Parameters
mixed $value
value to be converted to PHP equivalent
Returns
mixed

boolval() public static deprecated ¶

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

build() 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
Throws
InvalidArgumentException
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
string

getName() public ¶

getName( )

Returns type identifier name for this object

Returns
string

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


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
mixed
A new primary key value.
See
Cake\Database\Type\UuidType

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
3.1.8 This method is now unused.
Parameters
mixed $value
The value to convert to a string.
Returns
boolean

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
Returns
mixed

Properties detail

$_format ¶

protected string

Date format for DateTime object

'Y-m-d'
Follow @CakePHP
#IRC
OpenHub
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Logos & Trademarks
  • Community
  • Team
  • Issues (Github)
  • YouTube Channel
  • Get Involved
  • Bakery
  • Featured Resources
  • Newsletter
  • Certification
  • My CakePHP
  • CakeFest
  • Facebook
  • Twitter
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs