Merge pull request #1015 from compucorp/NEUSPRT-324-timestamp

NEUSPRT-324: Allow user to customize activity date format

.github/workflows/unit-test.yml

@@ -5,7 +5,7 @@ on: pull_request
 jobs:
   run-unit-tests:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     container: compucorp/civicrm-buildkit:1.3.1-php8.0-chrome
 
     env:

CRM/Civicase/Hook/BuildForm/AddCaseActivityDateFormatToDateSettings.php

@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * Add ActivityDateFormat To DateSettings BuildForm Hook Class.
+ */
+class CRM_Civicase_Hook_BuildForm_AddCaseActivityDateFormatToDateSettings {
+
+  /**
+   * Adds Activity DateFormat To Date Settings Form.
+   *
+   * @param CRM_Core_Form $form
+   *   Form Class object.
+   * @param string $formName
+   *   Form Name.
+   */
+  public function run(CRM_Core_Form &$form, $formName) {
+    if (!$this->shouldRun($formName)) {
+      return;
+    }
+
+    $this->addActivityDateFormatField($form);
+  }
+
+  /**
+   * Checks if this shook should run.
+   *
+   * @param string $formName
+   *   Form Name.
+   *
+   * @return bool
+   *   True if the hook should run.
+   */
+  public function shouldRun($formName) {
+    return $formName == CRM_Admin_Form_Setting_Date::class;
+  }
+
+  /**
+   * Add activity date format field.
+   *
+   * @param CRM_Core_Form $form
+   *   Form Class object.
+   */
+  private function addActivityDateFormatField($form) {
+    $name = 'civiCaseActivityDateformat';
+    $fieldName = '_qf_' . $name;
+    $field = [
+      $fieldName => [
+        'html_type' => 'text',
+        'title' => ts('Date Format: Activity Feed'),
+        'weight' => 5,
+      ],
+    ];
+
+    $form->add('text', $fieldName, $field[$fieldName]['title'], $field[$fieldName]['attributes']);
+    $value = Civi::settings()->get($name) ?? '%d %b %Y';
+    $form->setDefaults(array_merge($form->_defaultValues, [$fieldName => $value]));
+
+    CRM_Core_Region::instance('form-body')->add([
+      'template' => "CRM/Civicase/Form/CaseActivityDateFormat.tpl",
+    ]);
+  }
+
+}

CRM/Civicase/Hook/BuildForm/FormatCaseActivityDateFormat.php

@@ -0,0 +1,48 @@
+<?php
+
+use CRM_Civicase_ExtensionUtil as E;
+
+/**
+ * FormatCaseActivityDateFormat BuildForm Hook Class.
+ */
+class CRM_Civicase_Hook_BuildForm_FormatCaseActivityDateFormat {
+
+  /**
+   * Adds Activity DateFormat To Date Settings Form.
+   *
+   * @param CRM_Core_Form $form
+   *   Form Class object.
+   * @param string $formName
+   *   Form Name.
+   */
+  public function run(CRM_Core_Form &$form, $formName) {
+    if (!$this->shouldRun($form, $formName)) {
+      return;
+    }
+
+    $format = Civi::settings()->get('civiCaseActivityDateformat') ?? '%d %b %Y';
+    $dateValue = CRM_Utils_Date::customFormat($form->_defaultValues['activity_date_time'], $format);
+
+    \Civi::resources()->addVars('civicase', ['formatted_date' => $dateValue]);
+    \Civi::resources()->add([
+      'scriptFile' => [E::LONG_NAME, 'js/modify-activity-date.js'],
+      'region' => 'form-body',
+    ]);
+  }
+
+  /**
+   * Checks if this shook should run.
+   *
+   * @param CRM_Core_Form $form
+   *   Form Class object.
+   * @param string $formName
+   *   Form Name.
+   *
+   * @return bool
+   *   True if the hook should run.
+   */
+  public function shouldRun($form, $formName) {
+    return $formName == CRM_Activity_Form_Activity::class && $form->getAction() & CRM_Core_Action::VIEW;
+  }
+
+}

CRM/Civicase/Hook/PostProcess/SaveCaseActivityDateFormat.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * Save Activity DateFormat.
+ */
+class CRM_Civicase_Hook_PostProcess_SaveCaseActivityDateFormat {
+
+  /**
+   * Saves The Activity DateFormat field.
+   *
+   * @param string $formName
+   *   Form Name.
+   * @param CRM_Core_Form $form
+   *   Form Class object.
+   */
+  public function run($formName, CRM_Core_Form $form) {
+    if (!$this->shouldRun($formName)) {
+      return;
+    }
+
+    $this->saveCaseActivityDateFormatField($form);
+  }
+
+  /**
+   * Checks if this shook should run.
+   *
+   * @param string $formName
+   *   Form Name.
+   *
+   * @return bool
+   *   True if the hook should run.
+   */
+  public function shouldRun($formName) {
+    return $formName == CRM_Admin_Form_Setting_Date::class;
+  }
+
+  /**
+   * Saves The Activity DateFormat field.
+   *
+   * @param CRM_Core_Form $form
+   *   Form Class object.
+   */
+  public function saveCaseActivityDateFormatField(CRM_Core_Form &$form) {
+    $values = $form->getVar('_submitValues');
+    if (!empty($values['_qf_civiCaseActivityDateformat'])) {
+      Civi::settings()->set('civiCaseActivityDateformat', $values['_qf_civiCaseActivityDateformat']);
+    }
+  }
+
+}

ang/civicase/activity/card/directives/activity-card-big.directive.html

@@ -74,7 +74,7 @@
           </civicase-tooltip>
         </div>
         <!-- End - top section -->
-        <span class="civicase__activity-date" ng-class="{'civicase__overdue-activity-icon': activity.is_overdue}"><i class="material-icons">event</i>{{formatDate(activity.activity_date_time, 'DD MMM YYYY') }}</span>
+        <span class="civicase__activity-date" ng-class="{'civicase__overdue-activity-icon': activity.is_overdue}"><i class="material-icons">event</i>{{activity.formatted_activity_date_time}}</span>
         <!-- Subject -->
           <div class="civicase__activity-subject">{{ activity.subject }}</div>
         <!-- End - Subject -->

ang/civicase/activity/card/directives/activity-card-long.directive.html

@@ -84,7 +84,7 @@
             class="civicase__activity-date"
             ng-class="{'civicase__overdue-activity-icon': activity.is_overdue}">
             <span class="civicase__activity-date__with-year">
-              {{formatDate(activity.activity_date_time, 'DD MMM YYYY')}}
+              {{activity.formatted_activity_date_time}}
             </span>
             <span
               class="civicase__activity-date__without-year"

ang/civicase/activity/card/directives/activity-card-short.directive.html

@@ -11,7 +11,7 @@
         <span ng-if="activity.icon || activity.category.indexOf('milestone') > -1" activity-icon="activity"></span>
 
         <!-- Activity Date -->
-        <span class="civicase__activity-date" ng-class="{'civicase__overdue-activity-icon': activity.is_overdue}">{{ formatDate(activity.activity_date_time, 'DD MMM YYYY') }}</span>
+        <span class="civicase__activity-date" ng-class="{'civicase__overdue-activity-icon': activity.is_overdue}">{{activity.formatted_activity_date_time}}</span>
         <!-- End - Activity Date -->
 
         <span class="civicase__activity__right-container">

ang/civicase/activity/panel/directives/activity-panel.directive.html

@@ -96,7 +96,7 @@ <h3 class="panel-subtitle clearfix">
           <span
             class="civicase__activity-date"
             ng-class="{'civicase__overdue-activity-icon': activity.is_overdue}">
-            {{formatDate(activity.activity_date_time, 'DD MMM YYYY')}}
+            {{activity.formatted_activity_date_time}}
           </span>
           <!-- End - Activity Date -->
 

ang/civicase/shared/directives/file-uploader.directive.html

@@ -20,9 +20,9 @@ <h3>{{ts('Drop file here')}}</h3>
           <input type="text" class="form-control" id="uploadSubject" required placeholder="" ng-model="activity.subject"/>
         </div>
         <div class="row">
-          <div class="form-group col-md-4 civicase__ui-range">
+          <div class="form-group col-md-4 civicase__ui-range date_range">
             <div><label for="receivedDate">{{ts('Received Date')}}</label></div>
-            <input  id="receivedDate" class="form-control" crm-ui-datepicker="{time: false}" ng-model="activity.activity_date_time" placeholder=""/>
+            <input  id="receivedDate" class="form-control" crm-ui-datepicker="{time: true}" ng-model="activity.activity_date_time" placeholder=""/>
           </div>
         </div>
         <div class="row">
@@ -66,3 +66,12 @@ <h4 class="civicase__file-upload-name col-md-8" ng-bind="item.file.name"></h4>
     </div>
   </fieldset>
 </form>
+
+<style>
+  .date_range > .crm-form-date-wrapper {
+    display: flex !important;
+  }
+  .date_range.civicase__ui-range .crm-form-date {
+    width: 100% !important;
+  }
+</style>

ang/civicase/shared/directives/file-uploader.directive.js

@@ -179,7 +179,8 @@
       $scope.activity = {
         case_id: $scope.ctx.id,
         activity_type_id: 'File Upload',
-        subject: ''
+        subject: '',
+        activity_date_time: moment().format('YYYY-MM-DD HH:MM:SS')
       };
     }
 

api/v3/Activity/Getall.php

@@ -80,6 +80,10 @@ function civicrm_api3_activity_getall(array $params) {
     if (!empty($activityIdsToFetchContactsFor[$row['id']])) {
       $row = array_merge($activityIdsToFetchContactsFor[$row['id']], $row);
     }
+
+    if (!empty($row['activity_date_time'])) {
+      $row['formatted_activity_date_time'] = CRM_Utils_Date::customFormat($row['activity_date_time'], Civi::settings()->get('civiCaseActivityDateformat') ?? '%d %b %Y');
+    }
   }
 
   return $result;

civicase.php

@@ -163,6 +163,8 @@ function civicase_civicrm_buildForm($formName, &$form) {
     new CRM_Civicase_Hook_BuildForm_AddEntityReferenceToCustomField(),
     new CRM_Civicase_Hook_BuildForm_AttachQuotationToInvoiceMail(),
     new CRM_Civicase_Hook_BuildForm_RefreshInvoiceListOnUpdate(),
+    new CRM_Civicase_Hook_BuildForm_AddCaseActivityDateFormatToDateSettings(),
+    new CRM_Civicase_Hook_BuildForm_FormatCaseActivityDateFormat(),
   ];
 
   foreach ($hooks as $hook) {
@@ -312,6 +314,7 @@ function civicase_civicrm_postProcess($formName, &$form) {
     new CRM_Civicase_Hook_PostProcess_SaveCaseCategoryCustomFields(),
     new CRM_Civicase_Hook_PostProcess_SaveCaseCategoryFeature(),
     new CRM_Civicase_Hook_PostProcess_SaveQuotationsNotesSettings(),
+    new CRM_Civicase_Hook_PostProcess_SaveCaseActivityDateFormat(),
   ];
 
   foreach ($hooks as $hook) {

js/modify-activity-date.js

@@ -0,0 +1,7 @@
+CRM.$(function ($) {
+  (function () {
+    const date = CRM.vars.civicase.formatted_date;
+
+    CRM.$('.crm-activity-form-block-activity_date_time > td.view-value').text(date);
+  })();
+});

templates/CRM/Civicase/Form/CaseActivityDateFormat.tpl

@@ -0,0 +1,12 @@
+<table class="form-layout-compressed">
+<tr class="crm-date-form-block-_qf_civiCaseActivityDateformat">
+   <td class="label">{$form._qf_civiCaseActivityDateformat.label}</td>
+   <td>{$form._qf_civiCaseActivityDateformat.html}</td>
+</tr>
+</table>
+
+{literal}
+  <script>
+    CRM.$('.crm-date-form-block-dateformatTime').last().after(CRM.$('.crm-date-form-block-_qf_civiCaseActivityDateformat'))
+  </script>
+{/literal}