CRM/Case/Selector/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * This class is used to retrieve and display a range of contacts that match the given criteria.
  36  */
  37 class CRM_Case_Selector_Search extends CRM_Core_Selector_Base {
  38
  39   /**
  40    * This defines two actions- View and Edit.
  41    *
  42    * @var array
  43    */
  44   public static $_links = NULL;
  45
  46   /**
  47    * We use desc to remind us what that column is, name is used in the tpl
  48    *
  49    * @var array
  50    */
  51   public static $_columnHeaders;
  52
  53   /**
  54    * Properties of contact we're interested in displaying
  55    * @var array
  56    */
  57   public static $_properties = [
  58     'contact_id',
  59     'contact_type',
  60     'sort_name',
  61     'display_name',
  62     'case_id',
  63     'case_subject',
  64     'case_status_id',
  65     'case_status',
  66     'case_type_id',
  67     'case_type',
  68     'case_role',
  69     'phone',
  70   ];
  71
  72   /**
  73    * Are we restricting ourselves to a single contact
  74    *
  75    * @var bool
  76    */
  77   protected $_single = FALSE;
  78
  79   /**
  80    * Are we restricting ourselves to a single contact
  81    *
  82    * @var bool
  83    */
  84   protected $_limit = NULL;
  85
  86   /**
  87    * What context are we being invoked from
  88    *
  89    * @var string
  90    */
  91   protected $_context = NULL;
  92
  93   /**
  94    * QueryParams is the array returned by exportValues called on
  95    * the HTML_QuickForm_Controller for that page.
  96    *
  97    * @var array
  98    */
  99   public $_queryParams;
 100
 101   /**
 102    * Represent the type of selector
 103    *
 104    * @var int
 105    */
 106   protected $_action;
 107
 108   /**
 109    * The additional clause that we restrict the search with
 110    *
 111    * @var string
 112    */
 113   protected $_additionalClause = NULL;
 114
 115   /**
 116    * The query object
 117    *
 118    * @var string
 119    */
 120   protected $_query;
 121
 122   /**
 123    * Class constructor.
 124    *
 125    * @param array $queryParams
 126    *   Array of parameters for query.
 127    * @param \const|int $action - action of search basic or advanced.
 128    * @param string $additionalClause
 129    *   If the caller wants to further restrict the search (used in participations).
 130    * @param bool $single
 131    *   Are we dealing only with one contact?.
 132    * @param int $limit
 133    *   How many signers do we want returned.
 134    *
 135    * @param string $context
 136    *
 137    * @return \CRM_Case_Selector_Search
 138    */
 139   public function __construct(
 140     &$queryParams,
 141     $action = CRM_Core_Action::NONE,
 142     $additionalClause = NULL,
 143     $single = FALSE,
 144     $limit = NULL,
 145     $context = 'search'
 146   ) {
 147     // submitted form values
 148     $this->_queryParams = &$queryParams;
 149
 150     $this->_single = $single;
 151     $this->_limit = $limit;
 152     $this->_context = $context;
 153
 154     $this->_additionalClause = $additionalClause;
 155
 156     // type of selector
 157     $this->_action = $action;
 158
 159     $this->_query = new CRM_Contact_BAO_Query($this->_queryParams,
 160       CRM_Case_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_CASE,
 161         FALSE
 162       ),
 163       NULL, FALSE, FALSE,
 164       CRM_Contact_BAO_Query::MODE_CASE
 165     );
 166
 167     $this->_query->_distinctComponentClause = " civicrm_case.id ";
 168     $this->_query->_groupByComponentClause = " GROUP BY civicrm_case.id ";
 169   }
 170
 171   /**
 172    * This method returns the links that are given for each search row.
 173    * currently the links added for each row are
 174    *
 175    * - View
 176    * - Edit
 177    *
 178    * @param bool $isDeleted
 179    * @param null $key
 180    *
 181    * @return array
 182    */
 183   public static function &links($isDeleted = FALSE, $key = NULL) {
 184     $extraParams = ($key) ? "&key={$key}" : NULL;
 185
 186     if ($isDeleted) {
 187       self::$_links = [
 188         CRM_Core_Action::RENEW => [
 189           'name' => ts('Restore'),
 190           'url' => 'civicrm/contact/view/case',
 191           'qs' => 'reset=1&action=renew&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
 192           'ref' => 'restore-case',
 193           'title' => ts('Restore Case'),
 194         ],
 195       ];
 196     }
 197     else {
 198       self::$_links = [
 199         CRM_Core_Action::VIEW => [
 200           'name' => ts('Manage'),
 201           'url' => 'civicrm/contact/view/case',
 202           'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=case' . $extraParams,
 203           'ref' => 'manage-case',
 204           'class' => 'no-popup',
 205           'title' => ts('Manage Case'),
 206         ],
 207         CRM_Core_Action::DELETE => [
 208           'name' => ts('Delete'),
 209           'url' => 'civicrm/contact/view/case',
 210           'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
 211           'ref' => 'delete-case',
 212           'title' => ts('Delete Case'),
 213         ],
 214         CRM_Core_Action::UPDATE => [
 215           'name' => ts('Assign to Another Client'),
 216           'url' => 'civicrm/contact/view/case/editClient',
 217           'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams,
 218           'ref' => 'reassign',
 219           'class' => 'medium-popup',
 220           'title' => ts('Assign to Another Client'),
 221         ],
 222       ];
 223     }
 224
 225     $actionLinks = [];
 226     foreach (self::$_links as $key => $value) {
 227       $actionLinks['primaryActions'][$key] = $value;
 228     }
 229
 230     return $actionLinks;
 231   }
 232
 233   /**
 234    * Getter for array of the parameters required for creating pager.
 235    *
 236    * @param $action
 237    * @param array $params
 238    */
 239   public function getPagerParams($action, &$params) {
 240     $params['status'] = ts('Case') . ' %%StatusMessage%%';
 241     $params['csvString'] = NULL;
 242     if ($this->_limit) {
 243       $params['rowCount'] = $this->_limit;
 244     }
 245     else {
 246       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 247     }
 248
 249     $params['buttonTop'] = 'PagerTopButton';
 250     $params['buttonBottom'] = 'PagerBottomButton';
 251   }
 252
 253   /**
 254    * Returns total number of rows for the query.
 255    *
 256    * @param
 257    *
 258    * @return int
 259    *   Total number of rows
 260    */
 261   public function getTotalCount($action) {
 262     return $this->_query->searchQuery(0, 0, NULL,
 263       TRUE, FALSE,
 264       FALSE, FALSE,
 265       FALSE,
 266       $this->_additionalClause
 267     );
 268   }
 269
 270   /**
 271    * Returns all the rows in the given offset and rowCount.
 272    *
 273    * @param string $action
 274    *   The action being performed.
 275    * @param int $offset
 276    *   The row number to start from.
 277    * @param int $rowCount
 278    *   The number of rows to return.
 279    * @param string $sort
 280    *   The sql string that describes the sort order.
 281    * @param string $output
 282    *   What should the result set include (web/email/csv).
 283    *
 284    * @return int
 285    *   the total number of rows for this action
 286    */
 287   public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 288     $result = $this->_query->searchQuery($offset, $rowCount, $sort,
 289       FALSE, FALSE,
 290       FALSE, FALSE,
 291       FALSE,
 292       $this->_additionalClause
 293     );
 294     // process the result of the query
 295     $rows = [];
 296
 297     //CRM-4418 check for view, edit, delete
 298     $permissions = [CRM_Core_Permission::VIEW];
 299     if (CRM_Core_Permission::check('access all cases and activities')
 300       || CRM_Core_Permission::check('access my cases and activities')
 301     ) {
 302       $permissions[] = CRM_Core_Permission::EDIT;
 303     }
 304     if (CRM_Core_Permission::check('delete in CiviCase')) {
 305       $permissions[] = CRM_Core_Permission::DELETE;
 306     }
 307     $mask = CRM_Core_Action::mask($permissions);
 308
 309     $caseStatus = CRM_Core_OptionGroup::values('case_status', FALSE, FALSE, FALSE, " AND v.name = 'Urgent' ");
 310
 311     $scheduledInfo = [];
 312
 313     while ($result->fetch()) {
 314       $row = [];
 315       // the columns we are interested in
 316       foreach (self::$_properties as $property) {
 317         if (isset($result->$property)) {
 318           $row[$property] = $result->$property;
 319         }
 320       }
 321
 322       $isDeleted = FALSE;
 323       if ($result->case_deleted) {
 324         $isDeleted = TRUE;
 325         $row['case_status_id'] = empty($row['case_status_id']) ? "" : $row['case_status_id'] . '<br />' . ts('(deleted)');
 326       }
 327
 328       $scheduledInfo['case_id'][] = $result->case_id;
 329       $scheduledInfo['contact_id'][] = $result->contact_id;
 330       $scheduledInfo['case_deleted'] = $result->case_deleted;
 331       $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->case_id;
 332
 333       $links = self::links($isDeleted, $this->_key);
 334       $row['action'] = CRM_Core_Action::formLink($links['primaryActions'],
 335         $mask, [
 336           'id' => $result->case_id,
 337           'cid' => $result->contact_id,
 338           'cxt' => $this->_context,
 339         ],
 340         ts('more'),
 341         FALSE,
 342         'case.selector.actions',
 343         'Case',
 344         $result->case_id
 345       );
 346
 347       $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type
 348       );
 349
 350       //adding case manager to case selector.CRM-4510.
 351       $caseType = CRM_Case_BAO_Case::getCaseType($result->case_id, 'name');
 352       $row['casemanager'] = CRM_Case_BAO_Case::getCaseManagerContact($caseType, $result->case_id);
 353
 354       if (isset($result->case_status_id) &&
 355         array_key_exists($result->case_status_id, $caseStatus)
 356       ) {
 357         $row['class'] = "status-urgent";
 358       }
 359       else {
 360         $row['class'] = "status-normal";
 361       }
 362
 363       $rows[$result->case_id] = $row;
 364     }
 365
 366     //retrive the scheduled & recent Activity type and date for selector
 367     if (!empty($scheduledInfo)) {
 368       $schdeduledActivity = CRM_Case_BAO_Case::getNextScheduledActivity($scheduledInfo, 'upcoming');
 369       foreach ($schdeduledActivity as $key => $value) {
 370         $rows[$key]['case_scheduled_activity_date'] = $value['date'];
 371         $rows[$key]['case_scheduled_activity_type'] = $value['type'];
 372       }
 373       $recentActivity = CRM_Case_BAO_Case::getNextScheduledActivity($scheduledInfo, 'recent');
 374       foreach ($recentActivity as $key => $value) {
 375         $rows[$key]['case_recent_activity_date'] = $value['date'];
 376         $rows[$key]['case_recent_activity_type'] = $value['type'];
 377       }
 378     }
 379     return $rows;
 380   }
 381
 382   /**
 383    * @inheritDoc
 384    */
 385   public function getQILL() {
 386     return $this->_query->qill();
 387   }
 388
 389   /**
 390    * Returns the column headers as an array of tuples:
 391    * (name, sortName (key to the sort array))
 392    *
 393    * @param string $action
 394    *   The action being performed.
 395    * @param string $output
 396    *   What should the result set include (web/email/csv).
 397    *
 398    * @return array
 399    *   the column headers that need to be displayed
 400    */
 401   public function &getColumnHeaders($action = NULL, $output = NULL) {
 402     if (!isset(self::$_columnHeaders)) {
 403       self::$_columnHeaders = [
 404         [
 405           'name' => ts('Subject'),
 406           'direction' => CRM_Utils_Sort::DONTCARE,
 407         ],
 408         [
 409           'name' => ts('Status'),
 410           'sort' => 'case_status',
 411           'direction' => CRM_Utils_Sort::DONTCARE,
 412         ],
 413         [
 414           'name' => ts('Case Type'),
 415           'sort' => 'case_type',
 416           'direction' => CRM_Utils_Sort::DONTCARE,
 417         ],
 418         [
 419           'name' => ts('My Role'),
 420           'sort' => 'case_role',
 421           'direction' => CRM_Utils_Sort::DONTCARE,
 422         ],
 423         [
 424           'name' => ts('Case Manager'),
 425           'direction' => CRM_Utils_Sort::DONTCARE,
 426         ],
 427         [
 428           'name' => ts('Most Recent'),
 429           'sort' => 'case_recent_activity_date',
 430           'direction' => CRM_Utils_Sort::DONTCARE,
 431         ],
 432         [
 433           'name' => ts('Next Sched.'),
 434           'sort' => 'case_scheduled_activity_date',
 435           'direction' => CRM_Utils_Sort::DONTCARE,
 436         ],
 437         ['name' => ts('Actions')],
 438       ];
 439
 440       if (!$this->_single) {
 441         $pre = [
 442           [
 443             'name' => ts('Client'),
 444             'sort' => 'sort_name',
 445             'direction' => CRM_Utils_Sort::ASCENDING,
 446           ],
 447         ];
 448
 449         self::$_columnHeaders = array_merge($pre, self::$_columnHeaders);
 450       }
 451     }
 452     return self::$_columnHeaders;
 453   }
 454
 455   /**
 456    * @return mixed
 457    */
 458   public function alphabetQuery() {
 459     return $this->_query->alphabetQuery();
 460   }
 461
 462   /**
 463    * @return string
 464    */
 465   public function &getQuery() {
 466     return $this->_query;
 467   }
 468
 469   /**
 470    * Name of export file.
 471    *
 472    * @param string $output
 473    *   Type of output.
 474    *
 475    * @return string
 476    *   name of the file
 477    */
 478   public function getExportFileName($output = 'csv') {
 479     return ts('Case Search');
 480   }
 481
 482   /**
 483    * Add the set of "actionLinks" to the case activity
 484    *
 485    * @param int $caseID
 486    * @param int $contactID
 487    * @param int $userID
 488    * @param string $context
 489    * @param \CRM_Core_DAO $dao
 490    *
 491    * @return string
 492    *   HTML formatted Link
 493    */
 494   public static function addCaseActivityLinks($caseID, $contactID, $userID, $context, $dao) {
 495     // FIXME: Why are we not using CRM_Core_Action for these links? This is too much manual work and likely to get out-of-sync with core markup.
 496     $caseActivityId = $dao->id;
 497     $allowView = CRM_Case_BAO_Case::checkPermission($caseActivityId, 'view', $dao->activity_type_id, $userID);
 498     $allowEdit = CRM_Case_BAO_Case::checkPermission($caseActivityId, 'edit', $dao->activity_type_id, $userID);
 499     $allowDelete = CRM_Case_BAO_Case::checkPermission($caseActivityId, 'delete', $dao->activity_type_id, $userID);
 500     $emailActivityTypeIDs = [
 501       'Email' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Email'),
 502       'Inbound Email' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Inbound Email'),
 503     ];
 504     $url = CRM_Utils_System::url("civicrm/case/activity",
 505       "reset=1&cid={$contactID}&caseid={$caseID}", FALSE, NULL, FALSE
 506     );
 507     $contextUrl = '';
 508     if ($context == 'fulltext') {
 509       $contextUrl = "&context={$context}";
 510     }
 511     $editUrl = "{$url}&action=update{$contextUrl}";
 512     $deleteUrl = "{$url}&action=delete{$contextUrl}";
 513     $restoreUrl = "{$url}&action=renew{$contextUrl}";
 514     $viewTitle = ts('View activity');
 515     $caseDeleted = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_Case', $caseID, 'is_deleted');
 516
 517     $url = "";
 518     $css = 'class="action-item crm-hover-button"';
 519     if ($allowView) {
 520       $viewUrl = CRM_Utils_System::url('civicrm/case/activity/view', array('cid' => $contactID, 'aid' => $caseActivityId));
 521       $url = '<a ' . str_replace('action-item', 'action-item medium-pop-up', $css) . 'href="' . $viewUrl . '" title="' . $viewTitle . '">' . ts('View') . '</a>';
 522     }
 523     $additionalUrl = "&id={$caseActivityId}";
 524     if (!$dao->deleted) {
 525       //hide edit link of activity type email.CRM-4530.
 526       if (!in_array($dao->type, $emailActivityTypeIDs)) {
 527         //hide Edit link if activity type is NOT editable (special case activities).CRM-5871
 528         if ($allowEdit) {
 529           $url .= '<a ' . $css . ' href="' . $editUrl . $additionalUrl . '">' . ts('Edit') . '</a> ';
 530         }
 531       }
 532       if ($allowDelete) {
 533         $url .= ' <a ' . str_replace('action-item', 'action-item small-popup', $css) . ' href="' . $deleteUrl . $additionalUrl . '">' . ts('Delete') . '</a>';
 534       }
 535     }
 536     elseif (!$caseDeleted) {
 537       $url = ' <a ' . $css . ' href="' . $restoreUrl . $additionalUrl . '">' . ts('Restore') . '</a>';
 538     }
 539
 540     //check for operations.
 541     if (CRM_Case_BAO_Case::checkPermission($caseActivityId, 'Move To Case', $dao->activity_type_id)) {
 542       $url .= ' <a ' . $css . ' href="#" onClick="Javascript:fileOnCase( \'move\',' . $caseActivityId . ', ' . $caseID . ', this ); return false;">' . ts('Move To Case') . '</a> ';
 543     }
 544     if (CRM_Case_BAO_Case::checkPermission($caseActivityId, 'Copy To Case', $dao->activity_type_id)) {
 545       $url .= ' <a ' . $css . ' href="#" onClick="Javascript:fileOnCase( \'copy\',' . $caseActivityId . ',' . $caseID . ', this ); return false;">' . ts('Copy To Case') . '</a> ';
 546     }
 547     // if there are file attachments we will return how many and, if only one, add a link to it
 548     if (!empty($dao->attachment_ids)) {
 549       $url .= implode(' ', CRM_Core_BAO_File::paperIconAttachment('civicrm_activity', $caseActivityId));
 550     }
 551
 552     return $url;
 553   }
 554
 555 }