CRM/Case/Form/Task.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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2019
  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     $this->_contactIds = CRM_Core_DAO::getContactIDsFromComponent($this->_entityIds,
  54       'civicrm_case_contact', 'case_id'
  55     );
  56   }
  57
  58   /**
  59    * Get the query mode (eg. CRM_Core_BAO_Query::MODE_CASE)
  60    *
  61    * @return int
  62    */
  63   public function getQueryMode() {
  64     return CRM_Contact_BAO_Query::MODE_CASE;
  65   }
  66
  67 }