CRM/Mailing/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 mailing form task actions.
  20  * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
  21  */
  22 class CRM_Mailing_Form_Task extends CRM_Core_Form_Task {
  23
  24   /**
  25    * Build all the data structures needed to build the form.
  26    */
  27   public function preProcess() {
  28     self::preProcessCommon($this);
  29   }
  30
  31   /**
  32    * @param \CRM_Core_Form_Task $form
  33    *
  34    * @throws \CRM_Core_Exception
  35    */
  36   public static function preProcessCommon(&$form) {
  37     $values = $form->getSearchFormValues();
  38
  39     $form->_task = $values['task'] ?? NULL;
  40
  41     // ids are mailing event queue ids
  42     $ids = $form->getSelectedIDs($values);
  43
  44     if (!$ids) {
  45       $queryParams = $form->get('queryParams');
  46       $sortOrder = NULL;
  47       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
  48         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
  49       }
  50
  51       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
  52         CRM_Contact_BAO_Query::MODE_MAILING
  53       );
  54
  55       $result = $query->searchQuery(0, 0, $sortOrder);
  56       while ($result->fetch()) {
  57         $ids[] = $result->mailing_recipients_id;
  58       }
  59       $form->assign('totalSelectedMailingRecipients', $form->get('rowCount'));
  60     }
  61
  62     if (!empty($ids)) {
  63       $form->_componentClause = ' civicrm_mailing_recipients.id IN ( ' . implode(',', $ids) . ' ) ';
  64     }
  65
  66     // set the context for redirection for any task actions
  67     $session = CRM_Core_Session::singleton();
  68
  69     $fragment = 'search';
  70     if ($form->_action == CRM_Core_Action::ADVANCED) {
  71       $fragment .= '/advanced';
  72     }
  73
  74     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
  75     $urlParams = 'force=1';
  76     if (CRM_Utils_Rule::qfKey($qfKey)) {
  77       $urlParams .= "&qfKey=$qfKey";
  78     }
  79
  80     $url = CRM_Utils_System::url('civicrm/contact/' . $fragment, $urlParams);
  81     $session = CRM_Core_Session::singleton();
  82     $session->replaceUserContext($url);
  83   }
  84
  85   /**
  86    * Simple shell that derived classes can call to add buttons to
  87    * the form with a customized title for the main Submit
  88    *
  89    * @param string $title
  90    *   Title of the main button.
  91    * @param string $nextType
  92    * @param string $backType
  93    * @param bool $submitOnce
  94    */
  95   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
  96     $this->addButtons([
  97       [
  98         'type' => $nextType,
  99         'name' => $title,
 100         'isDefault' => TRUE,
 101       ],
 102       [
 103         'type' => $backType,
 104         'name' => ts('Cancel'),
 105       ],
 106     ]);
 107   }
 108
 109 }