CakePHP 3 temporary column add date

Date / time values ​​are all passed into one underlying structure, i.e. object DateTime

or DateTimeImmutable

, and therefore natural values ​​with date will have the added value of time ( 00:00:00

) and time - only values ​​have a date (today's date).

CakePHP will use specific subclasses depending on the SQL datatype, i.e.

• \Cake\I18n\Time
  
  or \Cake\I18n\FrozenTime
  
  for TIME
  
  , TIMESTAMP
  
  andDateTime
  
  
• \Cake\I18n\Date
  
  or \Cake\I18n\FrozenDate
  
  forDATE
  
  

Previous versions of CakePHP 3 had only \Cake\I18n\Time

.

It would be nice if there was a separate class for time-only types that would have the correct default-only output format, but until something like this is added, you'll have to take care of the output format.

Format in your views

It is up to you how to display this in your views. You can use i18nFormat()

class instance method easilyTIME

$record['start_time']->i18nFormat(
    [\IntlDateFormatter::NONE, \IntlDateFormatter::SHORT]
)

      

        
        
        
      

    

or TIME

, to show only the temporary part

$this->Time->i18nFormat(
    $record['start_time'],
    [\IntlDateFormatter::NONE, \IntlDateFormatter::SHORT]
)

      

        
        
        
      

    

Guess it doesn't hurt, if baking generates similar code according to the column type, you might want to suggest that as an improvement . As mentioned, using additional classes (or perhaps options) for time-only columns might be worth considering.

Use your own time class

If you wanted this behavior wherever the string representation of an object is used without having to manually invoke formatting, you can use an extended class \Cake\I18n\Time

or \Cake\I18n\FrozenTime

overridden $_toStringFormat

so that it formats the date accordingly.

SRC / i18n / FrozenTimeOnly.php

namespace App\I18n;

use Cake\I18n\FrozenTime;

class FrozenTimeOnly extends FrozenTime
{
    protected static $_toStringFormat = [
        \IntlDateFormatter::NONE,
        \IntlDateFormatter::SHORT
    ];
}

      

        
        
        
      

    

Src / config / bootstrap.php

use Cake\Database\Type\TimeType;
use App\I18n\FrozenTimeOnly;
TimeType::$dateTimeClass = FrozenTimeOnly::class;

// remove the default `useImmutable()` call, you may however
// want to keep further calls for formatting and stuff
Type::build('time'); 
// ...

      

        
        
        
      

    

This should be pretty much a self exploratory column TIME

that maps to TimeType

will now use App\I18n\FrozenTimeOnly

instead of the default one Cake\I18n\Time

.

DateTimeType::$dateTimeClass

obsolete

To handle this, you need a custom database type, which is pretty simple as well.

CSI / Database / Type / TimeOnlyType.php

namespace App\Database\Type;

use App\I18n\FrozenTimeOnly;
use Cake\Database\Type\TimeType;

class TimeOnlyType extends TimeType
{
    public function __construct($name)
    {
        parent::__construct($name);
        $this->_setClassName(FrozenTimeOnly::class, \DateTimeImmutable::class);
    }
}

      

        
        
        
      

    

It should be noted that currently this will set the data / time class twice, as the parent constructor will also call _setClassName()

where the given class will be instantiated.

Src / config / bootstrap.php

use App\Database\Type\TimeOnlyType;
Type::map('time', TimeOnlyType::class);

      

        
        
        
      

    

So what this will do is override the default type mapping TIME

to use a custom class \App\Database\Type\TimeOnlyType

, which in turn will use the class \App\I18n\TimeOnly

when converting database values ​​to PHP objects, which, when converted to string, will use the time format.

see also

• Cookbook> Time> Setting the default language and format strings
• Cookbook> Database Access and ORM> Database Basics> Adding Custom Types