CRM/Event/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates task actions for CiviEvent
  38  *
  39  */
  40 class CRM_Event_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 participant ids.
  65    *
  66    * @var array
  67    */
  68   protected $_participantIds;
  69
  70   /**
  71    * Build all the data structures needed to build the form.
  72    *
  73    * @param
  74    *
  75    * @return void
  76    */
  77   public function preProcess() {
  78     self::preProcessCommon($this);
  79   }
  80
  81   /**
  82    * @param CRM_Core_Form $form
  83    * @param bool $useTable
  84    */
  85   public static function preProcessCommon(&$form, $useTable = FALSE) {
  86     $form->_participantIds = array();
  87
  88     $values = $form->controller->exportValues($form->get('searchFormName'));
  89
  90     $form->_task = $values['task'];
  91     $tasks = CRM_Event_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission());
  92     if (!array_key_exists($form->_task, $tasks)) {
  93       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
  94     }
  95     $form->assign('taskName', $tasks[$form->_task]);
  96
  97     $ids = array();
  98     if ($values['radio_ts'] == 'ts_sel') {
  99       foreach ($values as $name => $value) {
 100         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
 101           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
 102         }
 103       }
 104     }
 105     else {
 106       $queryParams = $form->get('queryParams');
 107       $sortOrder = NULL;
 108       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
 109         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
 110       }
 111
 112       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
 113         CRM_Contact_BAO_Query::MODE_EVENT
 114       );
 115       $query->_distinctComponentClause = "civicrm_participant.id";
 116       $query->_groupByComponentClause = " GROUP BY civicrm_participant.id ";
 117       $result = $query->searchQuery(0, 0, $sortOrder);
 118       while ($result->fetch()) {
 119         $ids[] = $result->participant_id;
 120       }
 121     }
 122
 123     if (!empty($ids)) {
 124       $form->_componentClause = ' civicrm_participant.id IN ( ' . implode(',', $ids) . ' ) ';
 125       $form->assign('totalSelectedParticipants', count($ids));
 126     }
 127
 128     $form->_participantIds = $form->_componentIds = $ids;
 129
 130     //set the context for redirection for any task actions
 131     $session = CRM_Core_Session::singleton();
 132
 133     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 134     $urlParams = 'force=1';
 135     if (CRM_Utils_Rule::qfKey($qfKey)) {
 136       $urlParams .= "&qfKey=$qfKey";
 137     }
 138
 139     $searchFormName = strtolower($form->get('searchFormName'));
 140     if ($searchFormName == 'search') {
 141       $session->replaceUserContext(CRM_Utils_System::url('civicrm/event/search', $urlParams));
 142     }
 143     else {
 144       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
 145         $urlParams
 146       ));
 147     }
 148   }
 149
 150   /**
 151    * Given the participant id, compute the contact id
 152    * since its used for things like send email
 153    */
 154   public function setContactIDs() {
 155     $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent($this->_participantIds,
 156       'civicrm_participant'
 157     );
 158   }
 159
 160   /**
 161    * Simple shell that derived classes can call to add buttons to.
 162    * the form with a customized title for the main Submit
 163    *
 164    * @param string $title
 165    *   Title of the main button.
 166    * @param string $nextType
 167    * @param string $backType
 168    * @param bool $submitOnce
 169    *
 170    * @return void
 171    */
 172   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 173     $this->addButtons(array(
 174         array(
 175           'type' => $nextType,
 176           'name' => $title,
 177           'isDefault' => TRUE,
 178         ),
 179         array(
 180           'type' => $backType,
 181           'name' => ts('Cancel'),
 182         ),
 183       )
 184     );
 185   }
 186
 187 }