Merge pull request #262 from lopsided/master

Timestampable - add db field type parameter
KnpLabs · Dec 18, 2015 · 328c0ec · 328c0ec
2 parents 5bad0a2 + dbe5bfb
commit 328c0ec
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -461,6 +461,19 @@ so that when you try to call `getName` (for example) it will return you the tran
 
 ```
 
+If you wish to change the doctrine type of the database fields that will be created for timestampable models you can
+set the following parameter like so:
+
+``` yaml
+parameters:
+    knp.doctrine_behaviors.timestampable_subscriber.db_field_type: datetimetz
+```
+
+`datetimetz` here is a useful one to use if you are working with a Postgres database, otherwise you may encounter some
+timezone issues. For more information on this see: 
+<a href="http://doctrine-dbal.readthedocs.org/en/latest/reference/known-vendor-issues.html#datetime-datetimetz-and-time-types">http://doctrine-dbal.readthedocs.org/en/latest/reference/known-vendor-issues.html#datetime-datetimetz-and-time-types</a>
+
+The default type is `datetime`.
 
 <a name="blameable" id="blameable"></a>
 ### blameable

diff --git a/config/orm-services.yml b/config/orm-services.yml
@@ -12,6 +12,7 @@ parameters:
     knp.doctrine_behaviors.softdeletable_subscriber.softdeletable_trait: Knp\DoctrineBehaviors\Model\SoftDeletable\SoftDeletable
     knp.doctrine_behaviors.timestampable_subscriber.class: Knp\DoctrineBehaviors\ORM\Timestampable\TimestampableSubscriber
     knp.doctrine_behaviors.timestampable_subscriber.timestampable_trait: Knp\DoctrineBehaviors\Model\Timestampable\Timestampable
+    knp.doctrine_behaviors.timestampable_subscriber.db_field_type: datetime
     knp.doctrine_behaviors.blameable_subscriber.class: Knp\DoctrineBehaviors\ORM\Blameable\BlameableSubscriber
     knp.doctrine_behaviors.blameable_subscriber.blameable_trait: Knp\DoctrineBehaviors\Model\Blameable\Blameable
     knp.doctrine_behaviors.blameable_subscriber.user_callable.class: Knp\DoctrineBehaviors\ORM\Blameable\UserCallable
@@ -76,6 +77,7 @@ services:
             - "@knp.doctrine_behaviors.reflection.class_analyzer"
             - "%knp.doctrine_behaviors.reflection.is_recursive%"
             - "%knp.doctrine_behaviors.timestampable_subscriber.timestampable_trait%"
+            - "%knp.doctrine_behaviors.timestampable_subscriber.db_field_type%"
         tags:
             - { name: doctrine.event_subscriber }
 

diff --git a/src/ORM/Timestampable/TimestampableSubscriber.php b/src/ORM/Timestampable/TimestampableSubscriber.php
@@ -27,12 +27,14 @@
 class TimestampableSubscriber extends AbstractSubscriber
 {
     private $timestampableTrait;
+    private $dbFieldType;
 
-    public function __construct(ClassAnalyzer $classAnalyzer, $isRecursive, $timestampableTrait)
+    public function __construct(ClassAnalyzer $classAnalyzer, $isRecursive, $timestampableTrait, $dbFieldType)
     {
         parent::__construct($classAnalyzer, $isRecursive);
 
         $this->timestampableTrait = $timestampableTrait;
+        $this->dbFieldType = $dbFieldType;
     }
 
     public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs)
@@ -53,7 +55,7 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs)
                 if (!$classMetadata->hasField($field)) {
                     $classMetadata->mapField(array(
                         'fieldName' => $field,
-                        'type'      => 'datetime',
+                        'type'      => $this->dbFieldType,
                         'nullable'  => true
                     ));
                 }

diff --git a/tests/Knp/DoctrineBehaviors/ORM/TimestampableTest.php b/tests/Knp/DoctrineBehaviors/ORM/TimestampableTest.php
@@ -26,7 +26,8 @@ protected function getEventManager()
             new \Knp\DoctrineBehaviors\ORM\Timestampable\TimestampableSubscriber(
                 new ClassAnalyzer(),
                 false,
-                'Knp\DoctrineBehaviors\Model\Timestampable\Timestampable'
+                'Knp\DoctrineBehaviors\Model\Timestampable\Timestampable',
+                'datetime'
         ));
 
         return $em;