CRM/Mailing/Form/Task.php

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