CRM/Case/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates task actions for CiviEvent
  38  *
  39  */
  40 class CRM_Case_Form_Task extends CRM_Core_Form {
  41
  42   /**
  43    * the task being performed
  44    *
  45    * @var int
  46    */
  47   protected $_task;
  48
  49   /**
  50    * The additional clause that we restrict the search with
  51    *
  52    * @var string
  53    */
  54   protected $_componentClause = NULL;
  55
  56   /**
  57    * The array that holds all the component ids
  58    *
  59    * @var array
  60    */
  61   protected $_componentIds;
  62
  63   /**
  64    * The array that holds all the case ids
  65    *
  66    * @var array
  67    */
  68   protected $_caseIds;
  69
  70   /**
  71    * build all the data structures needed to build the form
  72    *
  73    * @param
  74    *
  75    * @return void
  76    * @access public
  77    */
  78   function preProcess() {
  79     self::preProcessCommon($this);
  80   }
  81
  82   /**
  83    * @param CRM_Core_Form $form
  84    * @param bool $useTable
  85    */
  86   static function preProcessCommon(&$form, $useTable = FALSE) {
  87     $form->_caseIds = array();
  88
  89     $values = $form->controller->exportValues($form->get('searchFormName'));
  90
  91     $form->_task = $values['task'];
  92     $caseTasks = CRM_Case_Task::tasks();
  93     $form->assign('taskName', $caseTasks[$form->_task]);
  94
  95     $ids = array();
  96     if ($values['radio_ts'] == 'ts_sel') {
  97       foreach ($values as $name => $value) {
  98         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  99           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
 100         }
 101       }
 102     }
 103     else {
 104       $queryParams = $form->get('queryParams');
 105       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
 106         CRM_Contact_BAO_Query::MODE_CASE
 107       );
 108       $query->_distinctComponentClause = " ( civicrm_case.id )";
 109       $query->_groupByComponentClause = " GROUP BY civicrm_case.id ";
 110       $result = $query->searchQuery(0, 0, NULL);
 111       while ($result->fetch()) {
 112         $ids[] = $result->case_id;
 113       }
 114     }
 115
 116     if (!empty($ids)) {
 117       $form->_componentClause = ' civicrm_case.id IN ( ' . implode(',', $ids) . ' ) ';
 118       $form->assign('totalSelectedCases', count($ids));
 119     }
 120
 121     $form->_caseIds = $form->_componentIds = $ids;
 122
 123     //set the context for redirection for any task actions
 124     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 125     $urlParams = 'force=1';
 126     if (CRM_Utils_Rule::qfKey($qfKey)) {
 127       $urlParams .= "&qfKey=$qfKey";
 128     }
 129
 130     $session = CRM_Core_Session::singleton();
 131     $searchFormName = strtolower($form->get('searchFormName'));
 132     if ($searchFormName == 'search') {
 133       $session->replaceUserContext(CRM_Utils_System::url('civicrm/case/search', $urlParams));
 134     }
 135     else {
 136       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
 137           $urlParams
 138         ));
 139     }
 140   }
 141
 142   /**
 143    * Given the signer id, compute the contact id
 144    * since its used for things like send email
 145    */
 146   public function setContactIDs() {
 147     $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent($this->_caseIds,
 148       'civicrm_case'
 149     );
 150   }
 151
 152   /**
 153    * simple shell that derived classes can call to add buttons to
 154    * the form with a customized title for the main Submit
 155    *
 156    * @param string $title title of the main button
 157    * @param string $nextType button type for the form after processing
 158    * @param string $backType
 159    * @param bool $submitOnce
 160    *
 161    * @return void
 162    * @access public
 163    */
 164   function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 165     $this->addButtons(array(
 166         array(
 167           'type' => $nextType,
 168           'name' => $title,
 169           'isDefault' => TRUE,
 170         ),
 171         array(
 172           'type' => $backType,
 173           'name' => ts('Cancel'),
 174         ),
 175       )
 176     );
 177   }
 178 }
 179