CRM/Contribute/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_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       $returnProperties = array('contribution_id' => 1);
 119       $sortOrder = $sortCol = NULL;
 120       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
 121         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
 122         //Include sort column in select clause.
 123         $sortCol = trim(str_replace(array('`', 'asc', 'desc'), '', $sortOrder));
 124         $returnProperties[$sortCol] = 1;
 125       }
 126
 127       $form->_includesSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams);
 128       $query = new CRM_Contact_BAO_Query($queryParams, $returnProperties, NULL, FALSE, FALSE,
 129         CRM_Contact_BAO_Query::MODE_CONTRIBUTE
 130       );
 131       // @todo the function CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled should handle this
 132       // can we remove? if not why not?
 133       if ($form->_includesSoftCredits) {
 134         $contactIds = $contributionContactIds = array();
 135         $query->_rowCountClause = " count(civicrm_contribution.id)";
 136         $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
 137       }
 138       else {
 139         $query->_distinctComponentClause = ' civicrm_contribution.id';
 140         $query->_groupByComponentClause = ' GROUP BY civicrm_contribution.id ';
 141       }
 142       $result = $query->searchQuery(0, 0, $sortOrder);
 143       while ($result->fetch()) {
 144         $ids[] = $result->contribution_id;
 145         if ($form->_includesSoftCredits) {
 146           $contactIds[$result->contact_id] = $result->contact_id;
 147           $contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id;
 148         }
 149       }
 150       $result->free();
 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     $form->set('contributionIds', $form->_contributionIds);
 166
 167     //set the context for redirection for any task actions
 168     $session = CRM_Core_Session::singleton();
 169
 170     $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form);
 171     $urlParams = 'force=1';
 172     if (CRM_Utils_Rule::qfKey($qfKey)) {
 173       $urlParams .= "&qfKey=$qfKey";
 174     }
 175
 176     $searchFormName = strtolower($form->get('searchFormName'));
 177     if ($searchFormName == 'search') {
 178       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/search', $urlParams));
 179     }
 180     else {
 181       $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName",
 182         $urlParams
 183       ));
 184     }
 185   }
 186
 187   /**
 188    * Sets contribution Ids for unit test.
 189    *
 190    * @param array $contributionIds
 191    */
 192   public function setContributionIds($contributionIds) {
 193     $this->_contributionIds = $contributionIds;
 194   }
 195
 196   /**
 197    * Given the contribution id, compute the contact id
 198    * since its used for things like send email
 199    */
 200   public function setContactIDs() {
 201     if (!$this->_includesSoftCredits) {
 202       $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent(
 203         $this->_contributionIds,
 204         'civicrm_contribution'
 205       );
 206     }
 207   }
 208
 209   /**
 210    * Simple shell that derived classes can call to add buttons to
 211    * the form with a customized title for the main Submit
 212    *
 213    * @param string $title
 214    *   Title of the main button.
 215    * @param string $nextType
 216    *   Button type for the form after processing.
 217    * @param string $backType
 218    * @param bool $submitOnce
 219    */
 220   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 221     $this->addButtons(array(
 222         array(
 223           'type' => $nextType,
 224           'name' => $title,
 225           'isDefault' => TRUE,
 226         ),
 227         array(
 228           'type' => $backType,
 229           'name' => ts('Cancel'),
 230         ),
 231       )
 232     );
 233   }
 234
 235 }