CRM/Campaign/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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * This class generates form components for relationship.
  36  */
  37 class CRM_Campaign_Form_Task extends CRM_Core_Form_Task {
  38
  39   /**
  40    * The array that holds all the voter ids
  41    *
  42    * @var array
  43    */
  44   protected $_voterIds;
  45
  46   /**
  47    * Build all the data structures needed to build the form.
  48    */
  49   public function preProcess() {
  50     $values = $this->controller->exportValues('Search');
  51
  52     $this->_task = $values['task'];
  53     $campaignTasks = CRM_Campaign_Task::tasks();
  54     $taskName = CRM_Utils_Array::value($this->_task, $campaignTasks);
  55     $this->assign('taskName', $taskName);
  56
  57     $ids = [];
  58     if ($values['radio_ts'] == 'ts_sel') {
  59       foreach ($values as $name => $value) {
  60         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  61           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  62         }
  63       }
  64     }
  65     else {
  66       $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
  67       $cacheKey = "civicrm search {$qfKey}";
  68       $allCids = Civi::service('prevnext')->getSelection($cacheKey, "getall");
  69       $ids = array_keys($allCids[$cacheKey]);
  70       $this->assign('totalSelectedVoters', count($ids));
  71     }
  72
  73     if (!empty($ids)) {
  74       $this->_componentClause = 'contact_a.id IN ( ' . implode(',', $ids) . ' ) ';
  75       $this->assign('totalSelectedVoters', count($ids));
  76     }
  77     $this->_voterIds = $this->_contactIds = $this->_componentIds = $ids;
  78
  79     $this->assign('totalSelectedContacts', count($this->_contactIds));
  80
  81     //set the context for redirection for any task actions
  82     $session = CRM_Core_Session::singleton();
  83     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
  84     $urlParams = 'force=1';
  85     if (CRM_Utils_Rule::qfKey($qfKey)) {
  86       $urlParams .= '&qfKey=' . $qfKey;
  87     }
  88     $session->replaceUserContext(CRM_Utils_System::url('civicrm/survey/search', $urlParams));
  89   }
  90
  91   /**
  92    * Given the voter id, compute the contact id
  93    * since its used for things like send email
  94    */
  95   public function setContactIDs() {
  96     $this->_contactIds = $this->_voterIds;
  97   }
  98
  99   /**
 100    * Simple shell that derived classes can call to add buttons to.
 101    * the form with a customized title for the main Submit
 102    *
 103    * @param string $title
 104    *   Title of the main button.
 105    * @param string $nextType
 106    *   Button type for the form after processing.
 107    * @param string $backType
 108    * @param bool $submitOnce
 109    */
 110   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 111     $this->addButtons([
 112       [
 113         'type' => $nextType,
 114         'name' => $title,
 115         'isDefault' => TRUE,
 116       ],
 117       [
 118         'type' => $backType,
 119         'name' => ts('Cancel'),
 120       ],
 121     ]);
 122   }
 123
 124 }