add created_date to civicrm_note

civicrm · Mar 19, 2021 · 641032e · 641032e
1 parent 959a795
commit 641032e
Show file tree

Hide file tree

Showing 7 changed files with 115 additions and 20 deletions.
diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php
@@ -477,6 +477,7 @@ private static function buildNoteTree($parentId, $maxDepth = 0, $snippet = FALSE
         $contact->fetch();
         $tree[$note->id]['createdBy'] = $contact->display_name;
         $tree[$note->id]['createdById'] = $createdById;
+        $tree[$note->id]['note_date'] = CRM_Utils_Date::customFormat($tree[$note->id]['note_date']);
         $tree[$note->id]['modified_date'] = CRM_Utils_Date::customFormat($tree[$note->id]['modified_date']);
 
         // paper icon view for attachments part

diff --git a/CRM/Core/DAO/Note.php b/CRM/Core/DAO/Note.php
@@ -6,7 +6,7 @@
  *
  * Generated from xml/schema/CRM/Core/Note.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:769d2ecb72a576a60f8a83940ab4c995)
+ * (GenCodeChecksum:376337f58ebba7da3702cdc9b14f4220)
  */
 
 /**
@@ -72,6 +72,20 @@ class CRM_Core_DAO_Note extends CRM_Core_DAO {
    */
   public $contact_id;
 
+  /**
+   * Date attached to the note.
+   *
+   * @var timestamp
+   */
+  public $note_date;
+
+  /**
+   * When the note was created.
+   *
+   * @var timestamp
+   */
+  public $created_date;
+
   /**
    * When was this note last modified/edited
    *
@@ -220,11 +234,43 @@ public static function &fields() {
           ],
           'add' => '1.1',
         ],
+        'note_date' => [
+          'name' => 'note_date',
+          'type' => CRM_Utils_Type::T_TIMESTAMP,
+          'title' => ts('Note Date'),
+          'description' => ts('Date attached to the note.'),
+          'where' => 'civicrm_note.note_date',
+          'default' => 'CURRENT_TIMESTAMP',
+          'table_name' => 'civicrm_note',
+          'entity' => 'Note',
+          'bao' => 'CRM_Core_BAO_Note',
+          'localizable' => 0,
+          'html' => [
+            'type' => 'Select Date',
+            'formatType' => 'activityDateTime',
+          ],
+          'add' => '5.36',
+        ],
+        'created_date' => [
+          'name' => 'created_date',
+          'type' => CRM_Utils_Type::T_TIMESTAMP,
+          'title' => ts('Created Date'),
+          'description' => ts('When the note was created.'),
+          'required' => TRUE,
+          'where' => 'civicrm_note.created_date',
+          'default' => 'CURRENT_TIMESTAMP',
+          'table_name' => 'civicrm_note',
+          'entity' => 'Note',
+          'bao' => 'CRM_Core_BAO_Note',
+          'localizable' => 0,
+          'add' => '5.36',
+        ],
         'modified_date' => [
           'name' => 'modified_date',
           'type' => CRM_Utils_Type::T_TIMESTAMP,
-          'title' => ts('Note Modified By'),
+          'title' => ts('Modified Date'),
           'description' => ts('When was this note last modified/edited'),
+          'required' => TRUE,
           'where' => 'civicrm_note.modified_date',
           'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP',
           'table_name' => 'civicrm_note',

diff --git a/CRM/Note/Form/Note.php b/CRM/Note/Form/Note.php
@@ -130,6 +130,7 @@ public function buildQuickForm() {
     }
 
     $this->addField('subject');
+    $this->addField('note_date', [], FALSE, FALSE);
     $this->addField('note', [], TRUE);
     $this->addField('privacy');
     $this->add('hidden', 'parent_id');

diff --git a/CRM/Upgrade/Incremental/php/FiveThirtySeven.php b/CRM/Upgrade/Incremental/php/FiveThirtySeven.php
@@ -52,21 +52,29 @@ public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
    * (change the x in the function name):
    */
 
-  //  /**
-  //   * Upgrade function.
-  //   *
-  //   * @param string $rev
-  //   */
-  //  public function upgrade_5_0_x($rev) {
-  //    $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
-  //    $this->addTask('Do the foo change', 'taskFoo', ...);
-  //    // Additional tasks here...
-  //    // Note: do not use ts() in the addTask description because it adds unnecessary strings to transifex.
-  //    // The above is an exception because 'Upgrade DB to %1: SQL' is generic & reusable.
-  //  }
+  /**
+   * Upgrade function.
+   *
+   * @param string $rev
+   */
+  public function upgrade_5_37_alpha1($rev) {
+    $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
+    $this->addTask('core-issue#2243 - Add note_date to civicrm_note', 'addColumn',
+     'civicrm_note', 'note_date', "timestamp NULL  DEFAULT CURRENT_TIMESTAMP COMMENT 'Date attached to the note'");
+    $this->addTask('core-issue#2243 - Add created_date to civicrm_note', 'addColumn',
+     'civicrm_note', 'created_date', "timestamp NULL  DEFAULT CURRENT_TIMESTAMP COMMENT 'When the note was created'");
+
+    $this->addTask('core-issue#2243 - Update existing note_date and created_date', 'updateNoteDates');
+  }
 
-  // public static function taskFoo(CRM_Queue_TaskContext $ctx, ...) {
-  //   return TRUE;
-  // }
+  /**
+   * @param \CRM_Queue_TaskContext $ctx
+   *
+   * @return bool
+   */
+  public static function updateNoteDates(CRM_Queue_TaskContext $ctx): bool {
+    CRM_Core_DAO::executeQuery("UPDATE civicrm_note SET note_date = modified_date, created_date = modified_date, modified_date = modified_date");
+    return TRUE;
+  }
 
 }
diff --git a/templates/CRM/Contact/Page/View/Note.tpl b/templates/CRM/Contact/Page/View/Note.tpl
@@ -13,7 +13,8 @@
         <div class="crm-block crm-content-block crm-note-view-block">
           <table class="crm-info-panel">
             <tr><td class="label">{ts}Subject{/ts}</td><td>{$note.subject}</td></tr>
-            <tr><td class="label">{ts}Date:{/ts}</td><td>{$note.modified_date|crmDate}</td></tr>
+            <tr><td class="label">{ts}Date:{/ts}</td><td>{$note.note_date|crmDate}</td></tr>
+            <tr><td class="label">{ts}Modified Date:{/ts}</td><td>{$note.modified_date|crmDate}</td></tr>
             <tr><td class="label">{ts}Privacy:{/ts}</td><td>{$note.privacy}</td></tr>
             <tr><td class="label">{ts}Note:{/ts}</td><td>{$note.note|nl2br}</td></tr>
 
@@ -33,7 +34,7 @@
                     <tr><th>{ts}Comment{/ts}</th><th>{ts}Created By{/ts}</th><th>{ts}Date{/ts}</th></tr>
                 </thead>
                 {foreach from=$comments item=comment}
-                    <tr class="{cycle values='odd-row,even-row'}"><td>{$comment.note}</td><td>{$comment.createdBy}</td><td>{$comment.modified_date}</td></tr>
+                  <tr class="{cycle values='odd-row,even-row'}"><td>{$comment.note}</td><td>{$comment.createdBy}</td><td>{$comment.note_date}</td><td>{$comment.modified_date}</td></tr>
                 {/foreach}
             </table>
         </fieldset>
@@ -51,6 +52,10 @@
                     {$form.subject.html}
                 </td>
             </tr>
+            <tr>
+              <td class="label">{$form.note_date.label}</td>
+              <td>{$form.note_date.html}</td>
+            </tr>
             <tr>
                 <td class="label">{$form.privacy.label}</td>
                 <td>
@@ -149,6 +154,8 @@
                         + '</td><td>'
                         + response['values'][i].subject
                         + '</td><td>'
+                        + response['values'][i].note_date
+                        + '</td><td>'
                         + response['values'][i].modified_date
                         + '</td><td>'
                         + '<a href="'+ urlTemplate + response['values'][i].createdById +'">'+ response['values'][i].createdBy +'</a>'
@@ -193,6 +200,7 @@
           <th>{ts}Note{/ts}</th>
           <th>{ts}Subject{/ts}</th>
           <th>{ts}Date{/ts}</th>
+          <th>{ts}Modified Date{/ts}</th>
           <th>{ts}Created By{/ts}</th>
           <th data-orderable="false">{ts}Attachment(s){/ts}</th>
           <th data-orderable="false"></th>
@@ -222,6 +230,7 @@
                 {/if}
             </td>
             <td class="crm-note-subject crmf-subject crm-editable">{$note.subject}</td>
+            <td class="crm-note-note_date" data-order="{$note.note_date}">{$note.note_date|crmDate}</td>
             <td class="crm-note-modified_date" data-order="{$note.modified_date}">{$note.modified_date|crmDate}</td>
             <td class="crm-note-createdBy">
                 <a href="{crmURL p='civicrm/contact/view' q="reset=1&cid=`$note.contact_id`"}">{$note.createdBy}</a>

diff --git a/tests/phpunit/api/v3/NoteTest.php b/tests/phpunit/api/v3/NoteTest.php
@@ -27,12 +27,15 @@ public function setUp() {
     $this->useTransaction(TRUE);
 
     $this->_contactID = $this->organizationCreate(NULL);
+    $this->_createdDate = date('Y-m-d H:i:s', strtotime('-10 years'));
 
     $this->_params = [
       'entity_table' => 'civicrm_contact',
       'entity_id' => $this->_contactID,
       'note' => 'Hello!!! m testing Note',
       'contact_id' => $this->_contactID,
+      'created_date' => $this->_createdDate,
+      'note_date' => $this->_createdDate,
       'modified_date' => '2011-01-31',
       'subject' => 'Test Note',
     ];
@@ -137,6 +140,8 @@ public function testCreate($version) {
 
     $result = $this->callAPIAndDocument('note', 'create', $this->_params, __FUNCTION__, __FILE__);
     $this->assertEquals($result['values'][$result['id']]['note'], 'Hello!!! m testing Note');
+    $this->assertEquals(date('Y-m-d', strtotime($this->_createdDate)), date('Y-m-d', strtotime($result['values'][$result['id']]['created_date'])));
+    $this->assertEquals(date('Y-m-d', strtotime($this->_createdDate)), date('Y-m-d', strtotime($result['values'][$result['id']]['note_date'])));
     $this->assertEquals(date('Y-m-d', strtotime($this->_params['modified_date'])), date('Y-m-d', strtotime($result['values'][$result['id']]['modified_date'])));
 
     $this->assertArrayHasKey('id', $result);
@@ -153,6 +158,8 @@ public function testCreateWithApostropheInString($version) {
       'entity_id' => $this->_contactID,
       'note' => "Hello!!! ' testing Note",
       'contact_id' => $this->_contactID,
+      'note_date' => $this->_createdDate,
+      'created_date' => $this->_createdDate,
       'modified_date' => '2011-01-31',
       'subject' => "With a '",
       'sequential' => 1,
@@ -221,6 +228,7 @@ public function testUpdate($version) {
       'contact_id' => $this->_contactID,
       'note' => 'Note1',
       'subject' => 'Hello World',
+      'note_date' => date('Y-m-d H:i:s', strtotime('-2 years')),
     ];
 
     // Update Note.
@@ -229,6 +237,8 @@ public function testUpdate($version) {
     $this->assertEquals($note['id'], $this->_noteID);
     $this->assertEquals($note['values'][$this->_noteID]['entity_id'], $this->_contactID);
     $this->assertEquals($note['values'][$this->_noteID]['entity_table'], 'civicrm_contact');
+    $this->assertEquals($note['values'][$this->_noteID]['note_date'], $params['note_date']);
+    $this->assertEquals(date('Y-m-d', strtotime($note['values'][$this->_noteID]['created_date'])), date('Y-m-d'));
     $this->assertEquals('Hello World', $note['values'][$this->_noteID]['subject']);
     $this->assertEquals('Note1', $note['values'][$this->_noteID]['note']);
   }

diff --git a/xml/schema/Core/Note.xml b/xml/schema/Core/Note.xml
@@ -86,11 +86,31 @@
     <add>1.1</add>
     <onDelete>SET NULL</onDelete>
   </foreignKey>
+  <field>
+    <name>note_date</name>
+    <title>Note Date</title>
+    <type>timestamp</type>
+    <add>5.36</add>
+    <default>CURRENT_TIMESTAMP</default>
+    <comment>Date attached to the note</comment>
+    <html>
+     <type>Select Date</type>
+     <formatType>activityDateTime</formatType>
+   </html>
+  </field>
+  <field>
+    <name>created_date</name>
+    <type>timestamp</type>
+    <comment>When the note was created.</comment>
+    <required>true</required>
+    <default>CURRENT_TIMESTAMP</default>
+    <add>5.36</add>
+  </field>
   <field>
     <name>modified_date</name>
-    <title>Note Modified By</title>
     <type>timestamp</type>
     <comment>When was this note last modified/edited</comment>
+    <required>true</required>
     <default>CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP</default>
     <add>1.1</add>
     <readonly>true</readonly>