Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
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 | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
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 | /** | |
fe482240 | 43 | * The task being performed. |
6a488035 TO |
44 | * |
45 | * @var int | |
46 | */ | |
47 | protected $_task; | |
48 | ||
49 | /** | |
fe482240 | 50 | * The additional clause that we restrict the search with. |
6a488035 TO |
51 | * |
52 | * @var string | |
53 | */ | |
54 | protected $_componentClause = NULL; | |
55 | ||
56 | /** | |
fe482240 | 57 | * The array that holds all the component ids. |
6a488035 TO |
58 | * |
59 | * @var array | |
60 | */ | |
61 | protected $_componentIds; | |
62 | ||
63 | /** | |
fe482240 | 64 | * The array that holds all the contribution ids. |
6a488035 TO |
65 | * |
66 | * @var array | |
67 | */ | |
68 | protected $_contributionIds; | |
69 | ||
70 | /** | |
fe482240 | 71 | * The array that holds all the contact ids. |
6a488035 TO |
72 | * |
73 | * @var array | |
74 | */ | |
75 | public $_contactIds; | |
76 | ||
34eec215 | 77 | /** |
fe482240 | 78 | * The array that holds all the mapping contribution and contact ids. |
34eec215 DS |
79 | * |
80 | * @var array | |
81 | */ | |
82 | protected $_contributionContactIds = array(); | |
83 | ||
84 | /** | |
fe482240 | 85 | * The flag to tell if there are soft credits included. |
34eec215 DS |
86 | * |
87 | * @var boolean | |
88 | */ | |
89 | public $_includesSoftCredits = FALSE; | |
90 | ||
6a488035 | 91 | /** |
fe482240 | 92 | * Build all the data structures needed to build the form. |
6a488035 TO |
93 | * |
94 | * @param | |
95 | * | |
96 | * @return void | |
6a488035 | 97 | */ |
00be9182 | 98 | public function preProcess() { |
6a488035 TO |
99 | self::preProcessCommon($this); |
100 | } | |
101 | ||
186c9c17 | 102 | /** |
c490a46a | 103 | * @param CRM_Core_Form $form |
186c9c17 EM |
104 | * @param bool $useTable |
105 | */ | |
00be9182 | 106 | public static function preProcessCommon(&$form, $useTable = FALSE) { |
6a488035 TO |
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'); | |
874c9be7 | 125 | $sortOrder = NULL; |
353ffa53 | 126 | if ($form->get(CRM_Utils_Sort::SORT_ORDER)) { |
481a74f4 | 127 | $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER); |
6a488035 | 128 | } |
665e5ec7 | 129 | |
34eec215 | 130 | $form->_includesSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams); |
6a488035 TO |
131 | $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE, |
132 | CRM_Contact_BAO_Query::MODE_CONTRIBUTE | |
133 | ); | |
34eec215 DS |
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 "; | |
0db6c3e1 TO |
138 | } |
139 | else { | |
34eec215 DS |
140 | $query->_distinctComponentClause = ' civicrm_contribution.id'; |
141 | $query->_groupByComponentClause = ' GROUP BY civicrm_contribution.id '; | |
142 | } | |
6a488035 TO |
143 | $result = $query->searchQuery(0, 0, $sortOrder); |
144 | while ($result->fetch()) { | |
145 | $ids[] = $result->contribution_id; | |
34eec215 DS |
146 | if ($form->_includesSoftCredits) { |
147 | $contactIds[$result->contact_id] = $result->contact_id; | |
148 | $contributionContactIds["{$result->contact_id}-{$result->contribution_id}"] = $result->contribution_id; | |
149 | } | |
6a488035 TO |
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 | } | |
b9884d60 | 159 | if (!empty($form->_includesSoftCredits) && !empty($contactIds)) { |
34eec215 DS |
160 | $form->_contactIds = $contactIds; |
161 | $form->_contributionContactIds = $contributionContactIds; | |
162 | } | |
6a488035 TO |
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", | |
353ffa53 TO |
181 | $urlParams |
182 | )); | |
6a488035 TO |
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() { | |
34eec215 DS |
191 | if (!$this->_includesSoftCredits) { |
192 | $this->_contactIds = &CRM_Core_DAO::getContactIDsFromComponent( | |
193 | $this->_contributionIds, | |
194 | 'civicrm_contribution' | |
195 | ); | |
196 | } | |
6a488035 TO |
197 | } |
198 | ||
199 | /** | |
100fef9d | 200 | * Simple shell that derived classes can call to add buttons to |
6a488035 TO |
201 | * the form with a customized title for the main Submit |
202 | * | |
014c4014 TO |
203 | * @param string $title |
204 | * Title of the main button. | |
205 | * @param string $nextType | |
206 | * Button type for the form after processing. | |
da6b46f4 EM |
207 | * @param string $backType |
208 | * @param bool $submitOnce | |
209 | * | |
6a488035 | 210 | * @return void |
6a488035 | 211 | */ |
00be9182 | 212 | public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) { |
6a488035 TO |
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 | } | |
96025800 | 226 | |
6a488035 | 227 | } |