CRM/Mailing/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 /**
  35  * This class generates form components for relationship
  36  */
  37 class CRM_Mailing_Form_Task extends CRM_Core_Form {
  38
  39   /**
  40    * The task being performed.
  41    *
  42    * @var int
  43    */
  44   protected $_task;
  45
  46   /**
  47    * The additional clause that we restrict the search with.
  48    *
  49    * @var string
  50    */
  51   protected $_componentClause = NULL;
  52
  53   /**
  54    * The array that holds all the component ids.
  55    *
  56    * @var array
  57    */
  58   protected $_componentIds;
  59
  60   /**
  61    * Build all the data structures needed to build the form.
  62    */
  63   public function preProcess() {
  64     self::preProcessCommon($this);
  65   }
  66
  67   /**
  68    * @param CRM_Core_Form $form
  69    * @param bool $useTable
  70    */
  71   public static function preProcessCommon(&$form, $useTable = FALSE) {
  72     $values = $form->controller->exportValues($form->get('searchFormName'));
  73
  74     $form->_task = CRM_Utils_Array::value('task', $values);
  75     $mailingTasks = CRM_Mailing_Task::tasks();
  76     $form->assign('taskName', CRM_Utils_Array::value('task', $values));
  77
  78     // ids are mailing event queue ids
  79     $ids = array();
  80     if ($values['radio_ts'] == 'ts_sel') {
  81       foreach ($values as $name => $value) {
  82         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
  83           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
  84         }
  85       }
  86     }
  87     else {
  88       $queryParams = $form->get('queryParams');
  89       $sortOrder = NULL;
  90       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
  91         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
  92       }
  93
  94       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
  95         CRM_Contact_BAO_Query::MODE_MAILING
  96       );
  97
  98       $result = $query->searchQuery(0, 0, $sortOrder);
  99       while ($result->fetch()) {
 100         $ids[] = $result->mailing_recipients_id;
 101       }
 102       $form->assign('totalSelectedMailingRecipients', $form->get('rowCount'));
 103     }
 104
 105     if (!empty($ids)) {
 106       $form->_componentClause = ' civicrm_mailing_recipients.id IN ( ' . implode(',', $ids) . ' ) ';
 107     }
 108
 109     // set the context for redirection for any task actions
 110     $session = CRM_Core_Session::singleton();
 111
 112     $fragment = 'search';
 113     if ($form->_action == CRM_Core_Action::ADVANCED) {
 114       $fragment .= '/advanced';
 115     }
 116
 117     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 118     $urlParams = 'force=1';
 119     if (CRM_Utils_Rule::qfKey($qfKey)) {
 120       $urlParams .= "&qfKey=$qfKey";
 121     }
 122
 123     $url = CRM_Utils_System::url('civicrm/contact/' . $fragment, $urlParams);
 124     $session = CRM_Core_Session::singleton();
 125     $session->replaceUserContext($url);
 126   }
 127
 128   /**
 129    * Simple shell that derived classes can call to add buttons to
 130    * the form with a customized title for the main Submit
 131    *
 132    * @param string $title
 133    *   Title of the main button.
 134    * @param string $nextType
 135    * @param string $backType
 136    * @param bool $submitOnce
 137    */
 138   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 139     $this->addButtons(array(
 140         array(
 141           'type' => $nextType,
 142           'name' => $title,
 143           'isDefault' => TRUE,
 144         ),
 145         array(
 146           'type' => $backType,
 147           'name' => ts('Cancel'),
 148         ),
 149       )
 150     );
 151   }
 152
 153 }