Fix double-negative in function signature
authorColeman Watts <coleman@civicrm.org>
Mon, 13 Mar 2017 13:57:37 +0000 (09:57 -0400)
committerColeman Watts <coleman@civicrm.org>
Tue, 14 Mar 2017 01:20:39 +0000 (21:20 -0400)
CRM/Case/BAO/Case.php

index b240d85e8bf7a77f346be630d6ef672c33d57429..de60d0c338b0854346a6b1cf4e7182deb58d2e0e 100644 (file)
@@ -1204,18 +1204,19 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
    *
    * @param int $caseID
    *   Case id.
-   * @param bool $skipDetails
+   * @param bool $includeDetails
    *   If true include details of contacts.
    *
    * @return array
    *   array of return properties
    *
    */
-  public static function getRelatedContacts($caseID, $skipDetails = FALSE) {
+  public static function getRelatedContacts($caseID, $includeDetails = TRUE) {
     $caseRoles = array();
-    if (!$skipDetails) {
+    if ($includeDetails) {
       $caseInfo = civicrm_api3('Case', 'getsingle', array(
         'id' => $caseID,
+        // Most efficient way of retrieving definition is to also include case type id and name so the api doesn't have to look it up separately
         'return' => array('case_type_id', 'case_type_id.name', 'case_type_id.definition'),
       ));
       if (!empty($caseInfo['case_type_id.definition']['caseRoles'])) {
@@ -1239,7 +1240,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
     $dao = CRM_Core_DAO::executeQuery($query, $params);
 
     while ($dao->fetch()) {
-      if ($skipDetails) {
+      if (!$includeDetails) {
         $values[$dao->id] = 1;
       }
       else {
@@ -1251,6 +1252,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
           'role' => $dao->role,
           'email' => $dao->email,
         );
+        // Add more info about the role (creator, manager)
         $role = CRM_Utils_Array::value($details['role'], $caseRoles);
         if ($role) {
           unset($role['name']);
@@ -1482,7 +1484,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
 
       // TODO: May want to replace this with a call to getRelatedAndGlobalContacts() when this feature is revisited.
       // (Or for efficiency call the global one outside the loop and then union with this each time.)
-      $contactDetails = self::getRelatedContacts($caseId, TRUE);
+      $contactDetails = self::getRelatedContacts($caseId, FALSE);
 
       if (!empty($contactDetails[$result['from']['id']])) {
         $params = array();