CRM/Mailing/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  * Class for mailing form task actions.
  36  * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
  37  */
  38 class CRM_Mailing_Form_Task extends CRM_Core_Form_Task {
  39
  40   /**
  41    * Build all the data structures needed to build the form.
  42    */
  43   public function preProcess() {
  44     self::preProcessCommon($this);
  45   }
  46
  47   /**
  48    * @param CRM_Core_Form $form
  49    */
  50   public static function preProcessCommon(&$form) {
  51     $values = $form->controller->exportValues($form->get('searchFormName'));
  52
  53     $form->_task = CRM_Utils_Array::value('task', $values);
  54     $mailingTasks = CRM_Mailing_Task::tasks();
  55     $form->assign('taskName', CRM_Utils_Array::value('task', $values));
  56
  57     // ids are mailing event queue ids
  58     $ids = [];
  59     if ($values['radio_ts'] == 'ts_sel') {
  60       foreach ($values as $name => $value) {
  61         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  62           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  63         }
  64       }
  65     }
  66     else {
  67       $queryParams = $form->get('queryParams');
  68       $sortOrder = NULL;
  69       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
  70         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
  71       }
  72
  73       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
  74         CRM_Contact_BAO_Query::MODE_MAILING
  75       );
  76
  77       $result = $query->searchQuery(0, 0, $sortOrder);
  78       while ($result->fetch()) {
  79         $ids[] = $result->mailing_recipients_id;
  80       }
  81       $form->assign('totalSelectedMailingRecipients', $form->get('rowCount'));
  82     }
  83
  84     if (!empty($ids)) {
  85       $form->_componentClause = ' civicrm_mailing_recipients.id IN ( ' . implode(',', $ids) . ' ) ';
  86     }
  87
  88     // set the context for redirection for any task actions
  89     $session = CRM_Core_Session::singleton();
  90
  91     $fragment = 'search';
  92     if ($form->_action == CRM_Core_Action::ADVANCED) {
  93       $fragment .= '/advanced';
  94     }
  95
  96     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
  97     $urlParams = 'force=1';
  98     if (CRM_Utils_Rule::qfKey($qfKey)) {
  99       $urlParams .= "&qfKey=$qfKey";
 100     }
 101
 102     $url = CRM_Utils_System::url('civicrm/contact/' . $fragment, $urlParams);
 103     $session = CRM_Core_Session::singleton();
 104     $session->replaceUserContext($url);
 105   }
 106
 107   /**
 108    * Simple shell that derived classes can call to add buttons to
 109    * the form with a customized title for the main Submit
 110    *
 111    * @param string $title
 112    *   Title of the main button.
 113    * @param string $nextType
 114    * @param string $backType
 115    * @param bool $submitOnce
 116    */
 117   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 118     $this->addButtons([
 119       [
 120         'type' => $nextType,
 121         'name' => $title,
 122         'isDefault' => TRUE,
 123       ],
 124       [
 125         'type' => $backType,
 126         'name' => ts('Cancel'),
 127       ],
 128     ]);
 129   }
 130
 131 }