CRM/Event/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Class for event form task actions.
  20  * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
  21  */
  22 class CRM_Event_Form_Task extends CRM_Core_Form_Task {
  23
  24   /**
  25    * The array that holds all the participant ids.
  26    *
  27    * @var array
  28    */
  29   protected $_participantIds;
  30
  31   /**
  32    * Build all the data structures needed to build the form.
  33    *
  34    * @param
  35    *
  36    * @return void
  37    */
  38   public function preProcess() {
  39     self::preProcessCommon($this);
  40   }
  41
  42   /**
  43    * @param CRM_Core_Form_Task $form
  44    */
  45   public static function preProcessCommon(&$form) {
  46     $form->_participantIds = [];
  47
  48     $values = $form->getSearchFormValues();
  49
  50     $form->_task = $values['task'];
  51     $tasks = CRM_Event_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission());
  52     if (!array_key_exists($form->_task, $tasks)) {
  53       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
  54     }
  55
  56     $ids = [];
  57     if ($values['radio_ts'] == 'ts_sel') {
  58       foreach ($values as $name => $value) {
  59         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  60           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  61         }
  62       }
  63     }
  64     else {
  65       $queryParams = $form->get('queryParams');
  66       $sortOrder = NULL;
  67       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
  68         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
  69       }
  70
  71       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
  72         CRM_Contact_BAO_Query::MODE_EVENT
  73       );
  74       $query->_distinctComponentClause = "civicrm_participant.id";
  75       $query->_groupByComponentClause = " GROUP BY civicrm_participant.id ";
  76       $result = $query->searchQuery(0, 0, $sortOrder);
  77       while ($result->fetch()) {
  78         $ids[] = $result->participant_id;
  79       }
  80     }
  81
  82     if (!empty($ids)) {
  83       $form->_componentClause = ' civicrm_participant.id IN ( ' . implode(',', $ids) . ' ) ';
  84       $form->assign('totalSelectedParticipants', count($ids));
  85     }
  86
  87     $form->_participantIds = $form->_componentIds = $ids;
  88
  89     //set the context for redirection for any task actions
  90     $session = CRM_Core_Session::singleton();
  91
  92     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
  93     $urlParams = 'force=1';
  94     if (CRM_Utils_Rule::qfKey($qfKey)) {
  95       $urlParams .= "&qfKey=$qfKey";
  96     }
  97
  98     $searchFormName = strtolower($form->get('searchFormName'));
  99     if ($searchFormName == 'search') {
 100       $session->replaceUserContext(CRM_Utils_System::url('civicrm/event/search', $urlParams));
 101     }
 102     else {
 103       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
 104         $urlParams
 105       ));
 106     }
 107   }
 108
 109   /**
 110    * Given the participant id, compute the contact id
 111    * since its used for things like send email
 112    */
 113   public function setContactIDs() {
 114     $this->_contactIds = CRM_Core_DAO::getContactIDsFromComponent($this->_participantIds,
 115       'civicrm_participant'
 116     );
 117   }
 118
 119   /**
 120    * Simple shell that derived classes can call to add buttons to.
 121    * the form with a customized title for the main Submit
 122    *
 123    * @param string $title
 124    *   Title of the main button.
 125    * @param string $nextType
 126    * @param string $backType
 127    * @param bool $submitOnce
 128    *
 129    * @return void
 130    */
 131   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 132     $this->addButtons([
 133       [
 134         'type' => $nextType,
 135         'name' => $title,
 136         'isDefault' => TRUE,
 137       ],
 138       [
 139         'type' => $backType,
 140         'name' => ts('Cancel'),
 141       ],
 142     ]);
 143   }
 144
 145 }