RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2025-02-02 21:41:45 +03:00
Code Issues Projects Releases Wiki Activity

Merge branch 'docs/#1497-update-orm-documentation-for-utc-datetime-type'

Browse Source 
Close #1497
This commit is contained in:
Marco Pivetta 2015-12-11 18:53:28 +01:00
commit 84f2bf7204
1 changed files with 35 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/en/cookbook/working-with-datetime.rst
View File

@ -85,43 +85,63 @@ the UTC time at the time of the booking and the timezone the event happened in.
use Doctrine\DBAL\Platforms\AbstractPlatform; use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\ConversionException; use Doctrine\DBAL\Types\ConversionException;
use Doctrine\DBAL\Types\DateTimeType;
class UTCDateTimeType extends DateTimeType class UTCDateTimeType extends DateTimeType
{ {
static private $utc = null; static private $utc;
public function convertToDatabaseValue($value, AbstractPlatform $platform) public function convertToDatabaseValue($value, AbstractPlatform $platform)
{ {
if ($value === null) { if ($value instanceof \DateTime) {
return null; $value->setTimezone(self::getUtc());
} }
return parent::convertToDatabaseValue($value, $platform);
return $value->format($platform->getDateTimeFormatString(),
(self::$utc) ? self::$utc : (self::$utc = new \DateTimeZone('UTC'))
);
} }
public function convertToPHPValue($value, AbstractPlatform $platform) public function convertToPHPValue($value, AbstractPlatform $platform)
{ {
if ($value === null) { if (null === $value || $value instanceof \DateTime) {
return null; return $value;
} }
$val = \DateTime::createFromFormat( $converted = \DateTime::createFromFormat(
$platform->getDateTimeFormatString(), $platform->getDateTimeFormatString(),
$value, $value,
(self::$utc) ? self::$utc : (self::$utc = new \DateTimeZone('UTC')) self::$utc ? self::$utc : self::$utc = new \DateTimeZone('UTC')
); );
if (!$val) {
throw ConversionException::conversionFailed($value, $this->getName()); if (! $converted) {
throw ConversionException::conversionFailedFormat(
$value,
$this->getName(),
$platform->getDateTimeFormatString()
);
} }
return $val;
return $converted;
} }
} }
This database type makes sure that every DateTime instance is always saved in UTC, relative This database type makes sure that every DateTime instance is always saved in UTC, relative
to the current timezone that the passed DateTime instance has. To be able to transform these values to the current timezone that the passed DateTime instance has.
To actually use this new type instead of the default ``datetime`` type, you need to run following
code before bootstrapping the ORM:
.. code-block:: php
<?php
use Doctrine\DBAL\Types\Type;
use DoctrineExtensions\DBAL\Types\UTCDateTimeType;
Type::overrideType('datetime', UTCDateTimeType::class);
Type::overrideType('datetimetz', UTCDateTimeType::class);
To be able to transform these values
back into their real timezone you have to save the timezone in a separate field of the entity back into their real timezone you have to save the timezone in a separate field of the entity
requiring timezoned datetimes: requiring timezoned datetimes: