Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
f299f7db | 6 | | Copyright CiviCRM LLC (c) 2004-2020 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
f299f7db | 31 | * @copyright CiviCRM LLC (c) 2004-2020 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
31aaf096 MW |
35 | * Class for contribute form task actions. |
36 | * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions. | |
6a488035 | 37 | */ |
31aaf096 | 38 | class CRM_Contribute_Form_Task extends CRM_Core_Form_Task { |
6a488035 TO |
39 | |
40 | /** | |
fe482240 | 41 | * The array that holds all the contribution ids. |
6a488035 TO |
42 | * |
43 | * @var array | |
44 | */ | |
45 | protected $_contributionIds; | |
46 | ||
34eec215 | 47 | /** |
fe482240 | 48 | * The array that holds all the mapping contribution and contact ids. |
34eec215 DS |
49 | * |
50 | * @var array | |
51 | */ | |
be2fb01f | 52 | protected $_contributionContactIds = []; |
34eec215 DS |
53 | |
54 | /** | |
fe482240 | 55 | * The flag to tell if there are soft credits included. |
34eec215 | 56 | * |
b67daa72 | 57 | * @var bool |
34eec215 DS |
58 | */ |
59 | public $_includesSoftCredits = FALSE; | |
60 | ||
6a488035 | 61 | /** |
fe482240 | 62 | * Build all the data structures needed to build the form. |
6a488035 | 63 | */ |
00be9182 | 64 | public function preProcess() { |
6a488035 TO |
65 | self::preProcessCommon($this); |
66 | } | |
67 | ||
186c9c17 | 68 | /** |
c490a46a | 69 | * @param CRM_Core_Form $form |
186c9c17 | 70 | */ |
2b089ce1 | 71 | public static function preProcessCommon(&$form) { |
be2fb01f | 72 | $form->_contributionIds = []; |
6a488035 TO |
73 | |
74 | $values = $form->controller->exportValues($form->get('searchFormName')); | |
75 | ||
7f20f38e | 76 | $form->_task = CRM_Utils_Array::value('task', $values); |
6a488035 | 77 | $contributeTasks = CRM_Contribute_Task::tasks(); |
7f20f38e | 78 | $form->assign('taskName', CRM_Utils_Array::value($form->_task, $contributeTasks)); |
6a488035 | 79 | |
be2fb01f | 80 | $ids = []; |
7f20f38e | 81 | if (isset($values['radio_ts']) && $values['radio_ts'] == 'ts_sel') { |
6a488035 TO |
82 | foreach ($values as $name => $value) { |
83 | if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) { | |
84 | $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN); | |
85 | } | |
86 | } | |
87 | } | |
88 | else { | |
89 | $queryParams = $form->get('queryParams'); | |
593e0d0b | 90 | $isTest = FALSE; |
85b68a11 CR |
91 | if (is_array($queryParams)) { |
92 | foreach ($queryParams as $fields) { | |
93 | if ($fields[0] == 'contribution_test') { | |
94 | $isTest = TRUE; | |
95 | break; | |
96 | } | |
593e0d0b E |
97 | } |
98 | } | |
99 | if (!$isTest) { | |
be2fb01f | 100 | $queryParams[] = [ |
593e0d0b E |
101 | 'contribution_test', |
102 | '=', | |
103 | 0, | |
104 | 0, | |
105 | 0, | |
be2fb01f | 106 | ]; |
593e0d0b | 107 | } |
be2fb01f | 108 | $returnProperties = ['contribution_id' => 1]; |
7f20f38e | 109 | $sortOrder = $sortCol = NULL; |
353ffa53 | 110 | if ($form->get(CRM_Utils_Sort::SORT_ORDER)) { |
481a74f4 | 111 | $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER); |
7f20f38e | 112 | //Include sort column in select clause. |
be2fb01f | 113 | $sortCol = trim(str_replace(['`', 'asc', 'desc'], '', $sortOrder)); |
7f20f38e | 114 | $returnProperties[$sortCol] = 1; |
6a488035 | 115 | } |
665e5ec7 | 116 | |
34eec215 | 117 | $form->_includesSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams); |
7f20f38e | 118 | $query = new CRM_Contact_BAO_Query($queryParams, $returnProperties, NULL, FALSE, FALSE, |
6a488035 TO |
119 | CRM_Contact_BAO_Query::MODE_CONTRIBUTE |
120 | ); | |
17caeafe | 121 | // @todo the function CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled should handle this |
122 | // can we remove? if not why not? | |
34eec215 | 123 | if ($form->_includesSoftCredits) { |
be2fb01f | 124 | $contactIds = $contributionContactIds = []; |
34eec215 DS |
125 | $query->_rowCountClause = " count(civicrm_contribution.id)"; |
126 | $query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id "; | |
0db6c3e1 TO |
127 | } |
128 | else { | |
34eec215 DS |
129 | $query->_distinctComponentClause = ' civicrm_contribution.id'; |
130 | $query->_groupByComponentClause = ' GROUP BY civicrm_contribution.id '; | |
131 | } | |
6a488035 TO |
132 | $result = $query->searchQuery(0, 0, $sortOrder); |
133 | while ($result->fetch()) { | |
134 | $ids[] = $result->contribution_id; | |
34eec215 DS |
135 | if ($form->_includesSoftCredits) { |
136 | $contactIds[$result->contact_id] = $result->contact_id; | |
137 | $contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id; | |
138 | } | |
6a488035 TO |
139 | } |
140 | $form->assign('totalSelectedContributions', $form->get('rowCount')); | |
141 | } | |
142 | ||
143 | if (!empty($ids)) { | |
144 | $form->_componentClause = ' civicrm_contribution.id IN ( ' . implode(',', $ids) . ' ) '; | |
145 | ||
146 | $form->assign('totalSelectedContributions', count($ids)); | |
147 | } | |
b9884d60 | 148 | if (!empty($form->_includesSoftCredits) && !empty($contactIds)) { |
34eec215 DS |
149 | $form->_contactIds = $contactIds; |
150 | $form->_contributionContactIds = $contributionContactIds; | |
151 | } | |
6a488035 TO |
152 | |
153 | $form->_contributionIds = $form->_componentIds = $ids; | |
7f20f38e | 154 | $form->set('contributionIds', $form->_contributionIds); |
6a488035 TO |
155 | |
156 | //set the context for redirection for any task actions | |
157 | $session = CRM_Core_Session::singleton(); | |
158 | ||
159 | $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $form); | |
160 | $urlParams = 'force=1'; | |
161 | if (CRM_Utils_Rule::qfKey($qfKey)) { | |
162 | $urlParams .= "&qfKey=$qfKey"; | |
163 | } | |
164 | ||
165 | $searchFormName = strtolower($form->get('searchFormName')); | |
166 | if ($searchFormName == 'search') { | |
167 | $session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/search', $urlParams)); | |
168 | } | |
169 | else { | |
170 | $session->replaceUserContext(CRM_Utils_System::url("civicrm/contact/search/$searchFormName", | |
353ffa53 TO |
171 | $urlParams |
172 | )); | |
6a488035 TO |
173 | } |
174 | } | |
175 | ||
59d861cb | 176 | /** |
177 | * Sets contribution Ids for unit test. | |
bc854509 | 178 | * |
179 | * @param array $contributionIds | |
59d861cb | 180 | */ |
181 | public function setContributionIds($contributionIds) { | |
182 | $this->_contributionIds = $contributionIds; | |
183 | } | |
184 | ||
6a488035 TO |
185 | /** |
186 | * Given the contribution id, compute the contact id | |
187 | * since its used for things like send email | |
188 | */ | |
189 | public function setContactIDs() { | |
34eec215 | 190 | if (!$this->_includesSoftCredits) { |
797ddfb4 | 191 | $this->_contactIds = CRM_Core_DAO::getContactIDsFromComponent( |
34eec215 DS |
192 | $this->_contributionIds, |
193 | 'civicrm_contribution' | |
194 | ); | |
195 | } | |
6a488035 TO |
196 | } |
197 | ||
198 | /** | |
100fef9d | 199 | * Simple shell that derived classes can call to add buttons to |
6a488035 TO |
200 | * the form with a customized title for the main Submit |
201 | * | |
014c4014 TO |
202 | * @param string $title |
203 | * Title of the main button. | |
204 | * @param string $nextType | |
205 | * Button type for the form after processing. | |
da6b46f4 EM |
206 | * @param string $backType |
207 | * @param bool $submitOnce | |
6a488035 | 208 | */ |
00be9182 | 209 | public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) { |
be2fb01f | 210 | $this->addButtons([ |
1330f57a SL |
211 | [ |
212 | 'type' => $nextType, | |
213 | 'name' => $title, | |
214 | 'isDefault' => TRUE, | |
215 | ], | |
216 | [ | |
217 | 'type' => $backType, | |
218 | 'name' => ts('Cancel'), | |
219 | ], | |
220 | ]); | |
6a488035 | 221 | } |
96025800 | 222 | |
6a488035 | 223 | } |