Cakephp3 Datetime型のミリ秒取得方法について

Question

###前提・実現したいこと
CakePHP3.4.2にてDatetime(3)に設定されているカラムのデータをfindにて取得するとミリ秒以下が削られてしまいます。
こちらをミリ秒まで取得する方法をご存じの方いらっしゃいませんでしょうか？

###Datetime型のDebugの内容は以下の通りです

object(Cake\I18n\FrozenTime) {
	'time' => '2017-03-02T01:40:10+09:00',
	'timezone' => 'Asia/Tokyo',
	'fixedNowTime' => false

}

DB上に実際に格納されている値:「2017-03-02 01:40:10.917」
i18nFormat('yyyy-MM-dd HH:mm:ss.S')も試してみましたが、ミリ秒が0になってしまいます。

###補足情報(言語/FW/ツール等のバージョンなど)
CakePHP 3.4.2
PHP 7.1.2
MariaDB 10.1.10

よろしくお願い致します。

###下記の回答を参考にさせて頂き動作が確認出来ましたのでコードを記載致します。

//bootstrap.php
Type::map('dtm', 'App\Database\Type\DateTimeMilliType');
Type::build('dtm')
    ->useImmutable();

//DateTimeMilliType.php
namespace App\Database\Type;

use Cake\Database\Type\DateTimeType;
use Cake\Database\Driver;

class DateTimeMilliType extends DateTimeType {

    protected $_format = 'Y-m-d H:i:s.u';

    public function toPHP($value, Driver $driver) {
        if ($value === null || strpos($value, '0000-00-00') === 0) {
            return null;
        }

        if (strpos($value, '.') !== false) {
            //list($value) = explode('.', $value);
        }

        $instance = clone $this->_datetimeInstance;
        $tmp_obj = $instance->createFromFormat('Y-m-d H:i:s.u', $value);
        return $tmp_obj;
    }

}

//table
    protected function _initializeSchema(Schema $schema) {
        
        $schema->columnType("modified", 'dtm');
        $schema->columnType("created", 'dtm');
        return $schema;
    }

//ミリ秒まで取得
//debug()だとミリ秒まで表示されないがformat()で表示されました
//i18nFormatでも何故かミリ秒が表示されませんでした
$item->created->format('Y-m-d H:i:s.u')

Answer 1

独自のTypeを定義してあげればできると思います。

src/Database/Type/DateTimeMilliType.php
※独自のTypeクラスを作成（DateTimeTypeを拡張してformatを変更しているだけ）

<?php
namespace App\Database\Type;

use Cake\Database\Type\DateTimeType;

class DateTimeMilliType extends DateTimeType {
    protected $_format = 'Y-m-d H:i:s.v';
}

config/bootstrap.phpの最後とかに以下の設定を追記

Type::map('datetimemilli', 'App\Database\Type\DateTimeMilliType');

src/Model/Table/TimesTable.php (Table名やカラム名は実際のものに合わせてください）
※独自に作成したクラスをカラムのtypeを指定する

<?php
namespace App\Model\Table;

use Cake\ORM\Table;
use Cake\Database\Schema\Table as Schema;

class TimesTable extends Table {
    protected function _initializeSchema(Schema $schema) {
        $schema->columnType("time", 'datetimemilli');
        return $schema;
    }
}

同じような質問があったので参考になるかと：CakePHP3.2のマイクロ秒でハマってます。
また、TypeについてはQiitaの記事が参考になるかと：【CakePHP3】 Type の話

Comments

[san11]

ご回答頂きまして誠にありがとうございました。
素晴らしいご回答に感謝致します。

頂いたコードにてミリ秒単位までの取得はできるようになったのですが、
'created' => '2017-03-02 01:40:10.917'
という文字列にて値が返ってきております。
コードを見る限りobject(Cake\I18n\FrozenTime) での返却になるのではないかと思っておりましたが、こちらは問題無い動作でしょうか？

何度も申し訳ございませんが、よろしくお願い申し上げます。

[popobot]

ほんとですね...これだったら単にstringタイプにマッピングしても同じかもしれません...。
$schema->columnType("time", 'string');

CakeのTime系のクラスはミリ秒に対応していないので、これだけだとダメみたいですね。すみません。
Time系のクラスもミリ秒に対応して、Typeクラス側もうまくクラス化するところを直せばクラス化できるかもしれません。（あとはPHPのDateTimeクラスを使う方法もかるかもしれません）

まぁ文字列でも良ければ、単にstringにするのもありかもです。加工はEntityでもできますので

[san11]

ご回答頂きましてありがとうございます。
頂いたコードを元に自己解決出来ましたので、コードを記載させて頂きました。
初心者なのでこれで問題ないか自信はありませんがとりあえず動作は確認できました･･･

[popobot]

素晴らしいですね！
どうやら自分の最初の回答はTableクラスのcolumnTypeにTYPOがあって、stringになっていたみたいですね... すみません。
DateTimeMilliTypeにtoPHPを追加したらformatはミリ秒表示できますね。