CRM-21829: Show Related Cases For Organizations

CRM/Civicase/APIHelpers/CaseList.php

@@ -84,6 +84,9 @@ public function getCaseList($params) {
       'tag_id.name', 'tag_id.color', 'tag_id.description',
     );
     $params['return'] = (isset($params['return']) ? array_merge($defaultAPIReturnedColumns, $params['return']) : $defaultAPIReturnedColumns);
+    if(isset($params['related_cids'])) {
+      $params['contact_id'] = $params['related_cids'];
+    }
     $cases = civicrm_api3('Case', 'getdetails', $params);
 
     foreach ($cases['values'] as &$case) {

CRM/Civicase/Page/ContactCaseTab.php

@@ -10,6 +10,13 @@ class CRM_Civicase_Page_ContactCaseTab extends CRM_Core_Page {
   public function run() {
     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', CRM_Core_DAO::$_nullObject, TRUE);
     $this->assign('cid', $cid);
+    // For Related cases tab (optional)
+    $relatedCases = CRM_Utils_Request::retrieve('relatedCases', 'Boolean');
+    if($relatedCases) {
+      $rcases = new CRM_Civicase_RelatedCases();
+      $related_cids = implode(',', $rcases->getOrganizationRelatedCaseContactIds($cid));
+      $this->assign('related_cids', $related_cids);
+    }
     parent::run();
   }
 

CRM/Civicase/RelatedCases.php

@@ -0,0 +1,70 @@
+<?php
+
+class CRM_Civicase_RelatedCases {
+
+  /**
+   * Retrieve contact ids of all contacts(with cases) related to given Organization contact.
+   *
+   * @param int $organizationId
+   *
+   * @return array
+   */
+  public function getOrganizationRelatedCaseContactIds($organizationId, $countOnly=FALSE) {
+    if(!$organizationId) {
+      return array();
+    }
+    $sql = 'SELECT';
+    if($countOnly) {
+      $sql .= ' COUNT(cc.case_id) ';
+    }
+    else {
+      $sql .= ' rel.contact_id_a as id ';
+    }
+    $sql .= "FROM civicrm_case_contact AS cc
+      INNER JOIN civicrm_relationship AS rel ON rel.contact_id_a = cc.contact_id
+      INNER JOIN civicrm_relationship_type AS rtype ON rel.relationship_type_id = rtype.id
+      WHERE 'Organization' IN (rtype.contact_type_a, rtype.contact_type_b)
+      AND %1 = CASE
+        WHEN (rtype.contact_type_a = 'Organization') THEN rel.contact_id_a
+        ELSE rel.contact_id_b
+      END";
+    $all = CRM_Core_DAO::executeQuery($sql, array(
+      1 => array($organizationId, 'Integer'),
+    ));
+    if($countOnly) {
+      return $all->fetchValue();
+    }
+    $all = $all->fetchAll();
+    $ids = array();
+    foreach($all as $each) {
+      if(!in_array($each['id'], $ids))
+        $ids[] = $each['id'];
+    }
+    return $ids;
+  }
+
+  /**
+   * Retrieve count of all cases of all contacts that are related to given Organization contact.
+   *
+   * @param int $organizationId
+   * @return int
+   */
+  public function getOrganizationRelatedCasesCount($organizationId) {
+    return $this->getOrganizationRelatedCaseContactIds($organizationId, TRUE);
+  }
+
+  /**
+   * Retrieve contact type for given contact id
+   *
+   * @param int $contact_id
+   * @return string
+   */
+  public function getContactType($contact_id) {
+    $sql = "SELECT contact_type FROM civicrm_contact
+      WHERE id = %1";
+    return CRM_Core_DAO::executeQuery($sql, array(
+      1 => array($contact_id, 'Integer'),
+    ))->fetchValue();
+  }
+}
+

ang/civicase/CaseList.js

@@ -15,7 +15,7 @@
   function loadCaseApiParams(filters, sort, page) {
     var returnParams = {
       sequential: 1,
-      return: ['subject', 'case_type_id', 'status_id', 'is_deleted', 'start_date', 'modified_date', 'contacts', 'activity_summary', 'category_count', 'tag_id.name', 'tag_id.color', 'tag_id.description'],
+      return: ['subject', 'case_type_id', 'status_id', 'is_deleted', 'start_date', 'modified_date', 'contacts', 'activity_summary', 'category_count', 'tag_id.name', 'tag_id.color', 'tag_id.description', 'related_cids'],
       options: {
         sort: sort.field + ' ' + sort.dir,
         limit: page.size,

civicase.php

@@ -9,7 +9,6 @@
  */
 function civicase_civicrm_tabset($tabsetName, &$tabs, $context) {
   $useAng = FALSE;
-
   switch ($tabsetName) {
     case 'civicrm/contact/view':
       $caseTabPresent = FALSE;
@@ -44,6 +43,23 @@ function civicase_civicrm_tabset($tabsetName, &$tabs, $context) {
         );
       }
 
+      $rcases = new CRM_Civicase_RelatedCases();
+      if(CRM_Core_Permission::check('basic case information') &&
+        $rcases->getContactType($context['contact_id']) == 'Organization' &&
+        Civi::settings()->get('civicaseRelatedCasesTab', 0)) {
+        $caseTabKey = array_search('case', array_column($tabs, 'id'));
+        $tabs[] = array(
+          'id' => 'related_case',
+          'url' => CRM_Utils_System::url('civicrm/case/contact-case-tab', array(
+            'cid' => $context['contact_id'],
+            'relatedCases' => TRUE,
+          )),
+          'title' => ts('Related Cases'),
+          'weight' => $tabs[$caseTabKey]['weight']+1,
+          'count' => $rcases->getOrganizationRelatedCasesCount($context['contact_id']),
+          'class' => 'livePage',
+        );
+      }
       break;
 
   }
@@ -195,7 +211,6 @@ function civicase_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
   _civicase_civix_civicrm_alterSettingsFolders($metaDataFolders);
 }
 
-
 /**
  * Implements hook_civicrm_buildForm().
  *
@@ -340,6 +355,14 @@ function civicase_civicrm_buildForm($formName, &$form) {
       }
     }
   }
+  if($formName == 'CRM_Admin_Form_Setting_Case') {
+    $form->addYesNo('_qf_civicaseRelatedCasesTab', ts('Display cases from related individuals on organisation contacts'));
+    $form->setDefaults(array('_qf_civicaseRelatedCasesTab' => Civi::settings()->get('civicaseRelatedCasesTab', 0)));
+    $templatePath = realpath(dirname(__FILE__)."/templates");
+    CRM_Core_Region::instance('page-body')->add(array(
+      'template' => "{$templatePath}/RelatedCasesField.tpl"
+    ));
+  }
 }
 
 /**
@@ -415,6 +438,12 @@ function civicase_civicrm_postProcess($formName, &$form) {
       civicrm_api3('Activity', 'delete', array('id' => $urlParams['draft_id']));
     }
   }
+  if($formName = 'CRM_Admin_Form_Setting_Case' && isset($form->_submitValues['_qf_civicaseRelatedCasesTab'])) {
+    if($form->_submitValues['_qf_civicaseRelatedCasesTab'] == 1)
+      Civi::settings()->set('civicaseRelatedCasesTab', 1);
+    else
+      Civi::settings()->set('civicaseRelatedCasesTab', 0);
+  }
 }
 
 /**

templates/CRM/Civicase/Page/ContactCaseTab.tpl

@@ -1,4 +1,8 @@
+{if $related_cids}
+<div id="civicaseRelatedContactTab" >
+{else}
 <div id="civicaseContactTab" >
+{/if}
   <div class="container" ng-view></div>
 </div>
 {literal}
@@ -10,9 +14,18 @@
           reloadOnSearch: false,
           resolve: {
             hiddenFilters: function() {
-              return {
-                "contact_id": [{/literal}{$cid|json}{literal}]
+              var ret = {
+                  "contact_id": [{/literal}{$cid|json}{literal}]
               };
+              {/literal}
+              {if $related_cids}
+              {literal}
+                var rcids = [{/literal}{$related_cids|json}{literal}];
+                ret["related_cids"] = rcids.toString().split(',');
+              {/literal}
+              {/if}
+              {literal}
+              return ret;
             }
           },
           controller: 'CivicaseCaseList',
@@ -22,7 +35,18 @@
     })(angular, CRM.$, CRM._);
 
     CRM.$(document).one('crmLoad', function(){
-      angular.bootstrap(document.getElementById('civicaseContactTab'), ['civicaseContactTab']);
+      {/literal}
+      {if $related_cids}
+      {literal}
+      var caseTab = document.getElementById('civicaseRelatedContactTab');
+      {/literal}
+      {else}
+      {literal}
+      var caseTab = document.getElementById('civicaseContactTab');
+      {/literal}
+      {/if}
+      {literal}
+      angular.bootstrap(caseTab, ['civicaseContactTab']);
     });
   </script>
 {/literal}

templates/RelatedCasesField.tpl

@@ -0,0 +1,12 @@
+<table>
+    <tr class="crm-case-form-block-civicaseRelatedCasesTab" id="civicaseRelatedCasesTab">
+        <td class="label">{$form._qf_civicaseRelatedCasesTab.label}</td>
+        <td>{$form._qf_civicaseRelatedCasesTab.html}<br />
+            <span class="description">{ts}With this checkbox enabled cases from individuals who are directly related to the organisation will be displayed on the organisation records on a tab called "Related Cases".{/ts}</span>
+        </td>
+    </tr>
+</table>
+<script type="text/javascript">
+    cj('form.CRM_Admin_Form_Setting_Case table.form-layout tbody').append(cj('#civicaseRelatedCasesTab'));
+</script>
+