Doctrine 2 ORM DateTime field in identifier - doctrine-orm

Question

In our DB tables, we columns refID and date are a composite primary key, with one field of the identifier being mapped as a datetime:
class corpWalletJournal
{
/**
* #ORM\Column(name="refID", type="bigint", nullable=false)
* #ORM\Id
* #ORM\GeneratedValue(strategy="NONE")
*/
private $refID;
/**
* #ORM\Column(name="date", type="datetime", nullable=false)
* #ORM\Id
* #ORM\GeneratedValue(strategy="NONE")
*/
private $date;
public function setRefID($refID)
{
$this->refID = $refID;
}
public function setDate(\DateTime $date)
{
$this->date = $date;
}
}
If we describe them in entity as #ORM\Id this code will return exception "cannot convert datetime to string"...
$filter = array(
'date' => $this->stringToDate($loopData['date']),
'refID' => $loopData['refID']
));
$oCorpWJ = $this->em->getRepository('EveDataBundle:corpWalletJournal')->findOneBy($filter);
// ...
$oCorpWJ->setDate($this->stringToDate($loopData['date']));
// ...
If we describe corpWalletJournal#date as a simple column, code works fine. Why?
How can we deal with it? We need to have both date and refID in the primary key.
ADDED:
So i created new class
use \DateTime;
class DateTimeEx extends DateTime
{
public function __toString()
{
return $this->format('Y-m-d h:i:s');
}
}
And new type for it
use Doctrine\DBAL\Types\Type;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Eve\DataBundle\Entity\Type\DateTimeEx;
class DateTimeEx extends Type
{
const DateTimeEx = 'datetime_ex';
public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
{
return 'my_datetime_ex';
}
public function convertToPHPValue($value, AbstractPlatform $platform)
{
return new DateTimeEx($value);
}
public function convertToDatabaseValue($value, AbstractPlatform $platform)
{
return $value->format('Y-m-d h:i:s');
}
public function getName()
{
return self::DateTimeEx;
}
public function canRequireSQLConversion()
{
return true;
}
}
How can i use them in entity?
My (edited) Type Class
use Doctrine\DBAL\Types\Type;
use Doctrine\DBAL\Platforms\AbstractPlatform;
class DateTimeEx extends Type
{
const DateTimeEx = 'datetime_ex';
public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
{
return 'my_datetime_ex';
}
public function convertToPHPValue($value, AbstractPlatform $platform)
{
return $value;
}
public function convertToDatabaseValue($value, AbstractPlatform $platform)
{
return $value;
}
public function getName()
{
return self::DateTimeEx;
}
}

Answer 1

Doctrine 2 ORM needs to convert identifier fields to strings in the UnitOfWork. This is required to have the EntityManager being able to track changes to your objects.
Since objects of type DateTime don't natively implement method __toString, converting them to strings is not as simple as casting them to strings.
Therefore, the default date, datetime and time types are not supported as part of the identifier.
To deal with it, you should define your own custom field type mydatetime mapped to your own MyDateTime class which implements __toString. That way, the ORM can handle identifiers also if they contain objects.
Here's an example of how that class may look like:
class MyDateTime extends \DateTime
{
public function __toString()
{
return $this->format('U');
}
}
And here's an example of how the custom DBAL type would look like:
use Doctrine\DBAL\Types\DateTimeType;
use Doctrine\DBAL\Platforms\AbstractPlatform;
class MyDateTimeType extends DateTimeType
{
public function convertToPHPValue($value, AbstractPlatform $platform)
{
$dateTime = parent::convertToPHPValue($value, $platform);
if ( ! $dateTime) {
return $dateTime;
}
$val = new MyDateTime('#' . $dateTime->format('U'));
$val->setTimezone($dateTime->getTimezone());
return $val;
}
public function requiresSQLCommentHint(AbstractPlatform $platform)
{
return true;
}
public function getName()
{
return 'mydatetime';
}
}
Then you register it with your ORM configuration during bootstrap (depends on the framework you are using). In symfony, it is documented on the symfony doctrine documentation.
After that, you can use it in your entities:
class corpWalletJournal
{
// ...
/**
* #ORM\Column(name="date", type="mydatetime", nullable=false)
* #ORM\Id
* #ORM\GeneratedValue(strategy="NONE")
*/
private $date;

Answer 2

Be careful with
return new DateTimeEx('#' . $dateTime->format('U'));
The timezone won't be good. You should do :
$val = new DateTimeEx('#' . $dateTime->format('U'));
$val->setTimezone($dateTime->getTimezone());
return $val;

Answer 3

Based on #Ocramius answer:
namespace App\Interface;
interface StringableDateTimeInterface extends \DateTimeInterface, \Stringable
{
}
namespace App\Type;
use App\Interface\StringableDateTimeInterface;
class DateTime extends \DateTime implements StringableDateTimeInterface
{
public function __toString(): string
{
return $this->format('U');
}
}
namespace App\DBAL;
use App\Type\DateTime;
use Doctrine\DBAL\Types\DateTimeType as DoctrineDateTimeType;
use Doctrine\DBAL\Platforms\AbstractPlatform;
class DateTimeType extends DoctrineDateTimeType
{
public function convertToPHPValue($value, AbstractPlatform $platform): mixed
{
$dateTime = parent::convertToPHPValue($value, $platform);
if (!$dateTime) {
return $dateTime;
}
$val = new DateTime('#' . $dateTime->format('U'));
$val->setTimezone($dateTime->getTimezone());
return $val;
}
}
namespace App\DBAL;
use App\Type\DateTime;
use Doctrine\DBAL\Types\DateType as DoctrineDateType;
use Doctrine\DBAL\Platforms\AbstractPlatform;
class DateType extends DoctrineDateType
{
public function convertToPHPValue($value, AbstractPlatform $platform): mixed
{
$dateTime = parent::convertToPHPValue($value, $platform);
if (!$dateTime) {
return $dateTime;
}
$val = new DateTime('#' . $dateTime->format('U'));
$val->setTimezone($dateTime->getTimezone());
return $val;
}
}
then add in config/packages/doctrine.yaml
doctrine:
dbal:
types:
datetime: App\DBAL\DateTimeType
date: App\DBAL\DateType
And finally in your Entity use like:
#[ORM\Id]
#[ORM\Column(type: 'date')]
private ?StringableDateTimeInterface $date;
public function getDate(): ?StringableDateTimeInterface
{
return $this->date;
}
public function setDate(StringableDateTimeInterface $date): self
{
$this->date = $date;
return $this;
}
Don't forget to create new App\Type\DateTime and not DateTime when setting the values of instance.