| 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_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 | * @access public |
| 98 | */ |
| 99 | function preProcess() { |
| 100 | self::preProcessCommon($this); |
| 101 | } |
| 102 | |
| 103 | static function preProcessCommon(&$form, $useTable = FALSE) { |
| 104 | $form->_contributionIds = array(); |
| 105 | |
| 106 | $values = $form->controller->exportValues($form->get('searchFormName')); |
| 107 | |
| 108 | $form->_task = $values['task']; |
| 109 | $contributeTasks = CRM_Contribute_Task::tasks(); |
| 110 | $form->assign('taskName', $contributeTasks[$form->_task]); |
| 111 | |
| 112 | $ids = array(); |
| 113 | if ($values['radio_ts'] == 'ts_sel') { |
| 114 | foreach ($values as $name => $value) { |
| 115 | if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) { |
| 116 | $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN); |
| 117 | } |
| 118 | } |
| 119 | } |
| 120 | else { |
| 121 | $queryParams = $form->get('queryParams'); |
| 122 | $sortOrder = null; |
| 123 | if ( $form->get( CRM_Utils_Sort::SORT_ORDER ) ) { |
| 124 | $sortOrder = $form->get( CRM_Utils_Sort::SORT_ORDER ); |
| 125 | } |
| 126 | |
| 127 | $form->_includesSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams); |
| 128 | $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE, |
| 129 | CRM_Contact_BAO_Query::MODE_CONTRIBUTE |
| 130 | ); |
| 131 | if ($form->_includesSoftCredits) { |
| 132 | $contactIds = $contributionContactIds = array(); |
| 133 | $query->_rowCountClause = " count(civicrm_contribution.id)"; |
| 134 | $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id "; |
| 135 | } else { |
| 136 | $query->_distinctComponentClause = ' civicrm_contribution.id'; |
| 137 | $query->_groupByComponentClause = ' GROUP BY civicrm_contribution.id '; |
| 138 | } |
| 139 | $result = $query->searchQuery(0, 0, $sortOrder); |
| 140 | while ($result->fetch()) { |
| 141 | $ids[] = $result->contribution_id; |
| 142 | if ($form->_includesSoftCredits) { |
| 143 | $contactIds[$result->contact_id] = $result->contact_id; |
| 144 | $contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id; |
| 145 | } |
| 146 | } |
| 147 | $form->assign('totalSelectedContributions', $form->get('rowCount')); |
| 148 | } |
| 149 | |
| 150 | if (!empty($ids)) { |
| 151 | $form->_componentClause = ' civicrm_contribution.id IN ( ' . implode(',', $ids) . ' ) '; |
| 152 | |
| 153 | $form->assign('totalSelectedContributions', count($ids)); |
| 154 | } |
| 155 | if ($form->_includesSoftCredits && !empty($contactIds)) { |
| 156 | $form->_contactIds = $contactIds; |
| 157 | $form->_contributionContactIds = $contributionContactIds; |
| 158 | } |
| 159 | |
| 160 | $form->_contributionIds = $form->_componentIds = $ids; |
| 161 | |
| 162 | //set the context for redirection for any task actions |
| 163 | $session = CRM_Core_Session::singleton(); |
| 164 | |
| 165 | $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form); |
| 166 | $urlParams = 'force=1'; |
| 167 | if (CRM_Utils_Rule::qfKey($qfKey)) { |
| 168 | $urlParams .= "&qfKey=$qfKey"; |
| 169 | } |
| 170 | |
| 171 | $searchFormName = strtolower($form->get('searchFormName')); |
| 172 | if ($searchFormName == 'search') { |
| 173 | $session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/search', $urlParams)); |
| 174 | } |
| 175 | else { |
| 176 | $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName", |
| 177 | $urlParams |
| 178 | )); |
| 179 | } |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * Given the contribution id, compute the contact id |
| 184 | * since its used for things like send email |
| 185 | */ |
| 186 | public function setContactIDs() { |
| 187 | if (!$this->_includesSoftCredits) { |
| 188 | $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent( |
| 189 | $this->_contributionIds, |
| 190 | 'civicrm_contribution' |
| 191 | ); |
| 192 | } |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * simple shell that derived classes can call to add buttons to |
| 197 | * the form with a customized title for the main Submit |
| 198 | * |
| 199 | * @param string $title title of the main button |
| 200 | * @param string $type button type for the form after processing |
| 201 | * |
| 202 | * @return void |
| 203 | * @access public |
| 204 | */ |
| 205 | function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) { |
| 206 | $this->addButtons(array( |
| 207 | array( |
| 208 | 'type' => $nextType, |
| 209 | 'name' => $title, |
| 210 | 'isDefault' => TRUE, |
| 211 | ), |
| 212 | array( |
| 213 | 'type' => $backType, |
| 214 | 'name' => ts('Cancel'), |
| 215 | ), |
| 216 | ) |
| 217 | ); |
| 218 | } |
| 219 | } |
| 220 | |