CRM/Case/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2020                                |
   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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2020
  31  */
  32
  33 /**
  34  * This class generates form task actions for CiviCase.
  35  */
  36 class CRM_Case_Form_Task extends CRM_Core_Form_Task {
  37
  38   /**
  39    * Must be set to entity table name (eg. civicrm_participant) by child class
  40    * @var string
  41    */
  42   public static $tableName = 'civicrm_case';
  43   /**
  44    * Must be set to entity shortname (eg. event)
  45    * @var string
  46    */
  47   public static $entityShortname = 'case';
  48
  49   /**
  50    * @inheritDoc
  51    */
  52   public function setContactIDs() {
  53     // @todo Parameters shouldn't be needed and should be class member
  54     // variables instead, set appropriately by each subclass.
  55     $this->_contactIds = $this->getContactIDsFromComponent($this->_entityIds,
  56       'civicrm_case_contact', 'case_id'
  57     );
  58   }
  59
  60   /**
  61    * Get the query mode (eg. CRM_Core_BAO_Query::MODE_CASE)
  62    *
  63    * @return int
  64    */
  65   public function getQueryMode() {
  66     return CRM_Contact_BAO_Query::MODE_CASE;
  67   }
  68
  69   /**
  70    * Override of CRM_Core_Form_Task::orderBy()
  71    *
  72    * @return string
  73    */
  74   public function orderBy() {
  75     if (empty($this->_entityIds)) {
  76       return '';
  77     }
  78     $order_array = [];
  79     foreach ($this->_entityIds as $item) {
  80       // Ordering by conditional in mysql. This evaluates to 0 or 1, so we
  81       // need to order DESC to get the '1'.
  82       $order_array[] = 'case_id = ' . CRM_Core_DAO::escapeString($item) . ' DESC';
  83     }
  84     return 'ORDER BY ' . implode(',', $order_array);
  85   }
  86
  87 }