CRM/Contribute/Form/Task.php

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