CRM/Contribute/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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_Contribute_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    * The array that holds all the contribution ids.
  65    *
  66    * @var array
  67    */
  68   protected $_contributionIds;
  69
  70   /**
  71    * The array that holds all the contact ids.
  72    *
  73    * @var array
  74    */
  75   public $_contactIds;
  76
  77   /**
  78    * The array that holds all the mapping contribution and contact ids.
  79    *
  80    * @var array
  81    */
  82   protected $_contributionContactIds = array();
  83
  84   /**
  85    * The flag to tell if there are soft credits included.
  86    *
  87    * @var boolean
  88    */
  89   public $_includesSoftCredits = FALSE;
  90
  91   /**
  92    * Build all the data structures needed to build the form.
  93    *
  94    * @param
  95    *
  96    * @return void
  97    */
  98   public function preProcess() {
  99     self::preProcessCommon($this);
 100   }
 101
 102   /**
 103    * @param CRM_Core_Form $form
 104    * @param bool $useTable
 105    */
 106   public static function preProcessCommon(&$form, $useTable = FALSE) {
 107     $form->_contributionIds = array();
 108
 109     $values = $form->controller->exportValues($form->get('searchFormName'));
 110
 111     $form->_task = $values['task'];
 112     $contributeTasks = CRM_Contribute_Task::tasks();
 113     $form->assign('taskName', $contributeTasks[$form->_task]);
 114
 115     $ids = array();
 116     if ($values['radio_ts'] == 'ts_sel') {
 117       foreach ($values as $name => $value) {
 118         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
 119           $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
 120         }
 121       }
 122     }
 123     else {
 124       $queryParams = $form->get('queryParams');
 125       $sortOrder = NULL;
 126       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
 127         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
 128       }
 129
 130       $form->_includesSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams);
 131       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
 132         CRM_Contact_BAO_Query::MODE_CONTRIBUTE
 133       );
 134       if ($form->_includesSoftCredits) {
 135         $contactIds = $contributionContactIds = array();
 136         $query->_rowCountClause = " count(civicrm_contribution.id)";
 137         $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
 138       }
 139       else {
 140         $query->_distinctComponentClause = ' civicrm_contribution.id';
 141         $query->_groupByComponentClause = ' GROUP BY civicrm_contribution.id ';
 142       }
 143       $result = $query->searchQuery(0, 0, $sortOrder);
 144       while ($result->fetch()) {
 145         $ids[] = $result->contribution_id;
 146         if ($form->_includesSoftCredits) {
 147           $contactIds[$result->contact_id] = $result->contact_id;
 148           $contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id;
 149         }
 150       }
 151       $form->assign('totalSelectedContributions', $form->get('rowCount'));
 152     }
 153
 154     if (!empty($ids)) {
 155       $form->_componentClause = ' civicrm_contribution.id IN ( ' . implode(',', $ids) . ' ) ';
 156
 157       $form->assign('totalSelectedContributions', count($ids));
 158     }
 159     if (!empty($form->_includesSoftCredits) && !empty($contactIds)) {
 160       $form->_contactIds = $contactIds;
 161       $form->_contributionContactIds = $contributionContactIds;
 162     }
 163
 164     $form->_contributionIds = $form->_componentIds = $ids;
 165
 166     //set the context for redirection for any task actions
 167     $session = CRM_Core_Session::singleton();
 168
 169     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 170     $urlParams = 'force=1';
 171     if (CRM_Utils_Rule::qfKey($qfKey)) {
 172       $urlParams .= "&qfKey=$qfKey";
 173     }
 174
 175     $searchFormName = strtolower($form->get('searchFormName'));
 176     if ($searchFormName == 'search') {
 177       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/search', $urlParams));
 178     }
 179     else {
 180       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
 181         $urlParams
 182       ));
 183     }
 184   }
 185
 186   /**
 187    * Given the contribution id, compute the contact id
 188    * since its used for things like send email
 189    */
 190   public function setContactIDs() {
 191     if (!$this->_includesSoftCredits) {
 192       $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent(
 193         $this->_contributionIds,
 194         'civicrm_contribution'
 195       );
 196     }
 197   }
 198
 199   /**
 200    * Simple shell that derived classes can call to add buttons to
 201    * the form with a customized title for the main Submit
 202    *
 203    * @param string $title
 204    *   Title of the main button.
 205    * @param string $nextType
 206    *   Button type for the form after processing.
 207    * @param string $backType
 208    * @param bool $submitOnce
 209    *
 210    * @return void
 211    */
 212   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 213     $this->addButtons(array(
 214         array(
 215           'type' => $nextType,
 216           'name' => $title,
 217           'isDefault' => TRUE,
 218         ),
 219         array(
 220           'type' => $backType,
 221           'name' => ts('Cancel'),
 222         ),
 223       )
 224     );
 225   }
 226
 227 }