Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class is used to retrieve and display a range of | |
38 | * contacts that match the given criteria (specifically for | |
39 | * results of advanced search options. | |
40 | * | |
41 | */ | |
42 | class CRM_Pledge_Selector_Search extends CRM_Core_Selector_Base { | |
43 | ||
44 | /** | |
45 | * This defines two actions- View and Edit. | |
46 | * | |
47 | * @var array | |
48 | * @static | |
49 | */ | |
50 | static $_links = NULL; | |
51 | ||
52 | /** | |
53 | * we use desc to remind us what that column is, name is used in the tpl | |
54 | * | |
55 | * @var array | |
56 | * @static | |
57 | */ | |
58 | static $_columnHeaders; | |
59 | ||
60 | /** | |
61 | * Properties of contact we're interested in displaying | |
62 | * @var array | |
63 | * @static | |
64 | */ | |
65 | static $_properties = array( | |
66 | 'contact_id', | |
67 | 'sort_name', | |
68 | 'display_name', | |
69 | 'pledge_id', | |
70 | 'pledge_amount', | |
71 | 'pledge_create_date', | |
72 | 'pledge_total_paid', | |
73 | 'pledge_next_pay_date', | |
74 | 'pledge_next_pay_amount', | |
75 | 'pledge_outstanding_amount', | |
76 | 'pledge_status_id', | |
77 | 'pledge_status', | |
78 | 'pledge_is_test', | |
79 | 'pledge_contribution_page_id', | |
6d3864ef | 80 | 'pledge_financial_type', |
6a488035 TO |
81 | 'pledge_campaign_id', |
82 | 'pledge_currency', | |
83 | ); | |
84 | ||
85 | /** | |
86 | * are we restricting ourselves to a single contact | |
87 | * | |
88 | * @access protected | |
89 | * @var boolean | |
90 | */ | |
91 | protected $_single = FALSE; | |
92 | ||
93 | /** | |
94 | * are we restricting ourselves to a single contact | |
95 | * | |
96 | * @access protected | |
97 | * @var boolean | |
98 | */ | |
99 | protected $_limit = NULL; | |
100 | ||
101 | /** | |
102 | * what context are we being invoked from | |
103 | * | |
104 | * @access protected | |
105 | * @var string | |
106 | */ | |
107 | protected $_context = NULL; | |
108 | ||
109 | /** | |
110 | * queryParams is the array returned by exportValues called on | |
111 | * the HTML_QuickForm_Controller for that page. | |
112 | * | |
113 | * @var array | |
114 | * @access protected | |
115 | */ | |
116 | public $_queryParams; | |
117 | ||
118 | /** | |
119 | * represent the type of selector | |
120 | * | |
121 | * @var int | |
122 | * @access protected | |
123 | */ | |
124 | protected $_action; | |
125 | ||
126 | /** | |
127 | * The additional clause that we restrict the search with | |
128 | * | |
129 | * @var string | |
130 | */ | |
131 | protected $_additionalClause = NULL; | |
132 | ||
133 | /** | |
134 | * The query object | |
135 | * | |
136 | * @var string | |
137 | */ | |
138 | protected $_query; | |
139 | ||
140 | /** | |
141 | * Class constructor | |
142 | * | |
fd31fa4c EM |
143 | * @param array $queryParams array of parameters for query |
144 | * @param \const|int $action - action of search basic or advanced. | |
145 | * @param string $additionalClause if the caller wants to further restrict the search (used in participations) | |
6a488035 | 146 | * @param boolean $single are we dealing only with one contact? |
fd31fa4c | 147 | * @param int $limit how many signers do we want returned |
6a488035 | 148 | * |
fd31fa4c EM |
149 | * @param string $context |
150 | * | |
151 | * @return \CRM_Pledge_Selector_Search | |
152 | @access public | |
6a488035 TO |
153 | */ |
154 | function __construct(&$queryParams, | |
155 | $action = CRM_Core_Action::NONE, | |
156 | $additionalClause = NULL, | |
157 | $single = FALSE, | |
158 | $limit = NULL, | |
159 | $context = 'search' | |
160 | ) { | |
161 | // submitted form values | |
162 | $this->_queryParams = &$queryParams; | |
163 | ||
164 | $this->_single = $single; | |
165 | $this->_limit = $limit; | |
166 | $this->_context = $context; | |
167 | ||
168 | $this->_additionalClause = $additionalClause; | |
169 | ||
170 | // type of selector | |
171 | $this->_action = $action; | |
172 | ||
173 | $this->_query = new CRM_Contact_BAO_Query($this->_queryParams, NULL, NULL, FALSE, FALSE, | |
174 | CRM_Contact_BAO_Query::MODE_PLEDGE | |
175 | ); | |
176 | ||
177 | $this->_query->_distinctComponentClause = "civicrm_pledge.id"; | |
178 | $this->_query->_groupByComponentClause = " GROUP BY civicrm_pledge.id "; | |
179 | } | |
180 | //end of constructor | |
181 | ||
182 | /** | |
183 | * This method returns the links that are given for each search row. | |
184 | * currently the links added for each row are | |
185 | * | |
186 | * - View | |
187 | * - Edit | |
188 | * | |
189 | * @return array | |
190 | * @access public | |
191 | * | |
192 | */ | |
9f6f062c DL |
193 | static function &links() { |
194 | $args = func_get_args(); | |
195 | $hideOption = CRM_Utils_Array::value(0, $args); | |
196 | $key = CRM_Utils_Array::value(1, $args); | |
197 | ||
6a488035 TO |
198 | $extraParams = ($key) ? "&key={$key}" : NULL; |
199 | ||
200 | $cancelExtra = ts('Cancelling this pledge will also cancel any scheduled (and not completed) pledge payments.') . ' ' . ts('This action cannot be undone.') . ' ' . ts('Do you want to continue?'); | |
201 | self::$_links = array( | |
202 | CRM_Core_Action::VIEW => array( | |
203 | 'name' => ts('View'), | |
204 | 'url' => 'civicrm/contact/view/pledge', | |
205 | 'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=pledge' . $extraParams, | |
206 | 'title' => ts('View Pledge'), | |
207 | ), | |
208 | CRM_Core_Action::UPDATE => array( | |
209 | 'name' => ts('Edit'), | |
210 | 'url' => 'civicrm/contact/view/pledge', | |
211 | 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams, | |
212 | 'title' => ts('Edit Pledge'), | |
213 | ), | |
214 | CRM_Core_Action::DETACH => array( | |
215 | 'name' => ts('Cancel'), | |
216 | 'url' => 'civicrm/contact/view/pledge', | |
217 | 'qs' => 'reset=1&action=detach&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams, | |
218 | 'extra' => 'onclick = "return confirm(\'' . $cancelExtra . '\');"', | |
219 | 'title' => ts('Cancel Pledge'), | |
220 | ), | |
221 | CRM_Core_Action::DELETE => array( | |
222 | 'name' => ts('Delete'), | |
223 | 'url' => 'civicrm/contact/view/pledge', | |
224 | 'qs' => 'reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%' . $extraParams, | |
225 | 'title' => ts('Delete Pledge'), | |
226 | ), | |
227 | ); | |
228 | ||
229 | ||
230 | if (in_array('Cancel', $hideOption)) { | |
231 | unset(self::$_links[CRM_Core_Action::DETACH]); | |
232 | } | |
233 | ||
234 | return self::$_links; | |
235 | } | |
236 | //end of function | |
237 | ||
238 | /** | |
239 | * getter for array of the parameters required for creating pager. | |
240 | * | |
da6b46f4 EM |
241 | * @param $action |
242 | * @param $params | |
243 | * | |
244 | * @internal param $ | |
6a488035 TO |
245 | * @access public |
246 | */ | |
247 | function getPagerParams($action, &$params) { | |
248 | $params['status'] = ts('Pledge') . ' %%StatusMessage%%'; | |
249 | $params['csvString'] = NULL; | |
250 | if ($this->_limit) { | |
251 | $params['rowCount'] = $this->_limit; | |
252 | } | |
253 | else { | |
254 | $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT; | |
255 | } | |
256 | ||
257 | $params['buttonTop'] = 'PagerTopButton'; | |
258 | $params['buttonBottom'] = 'PagerBottomButton'; | |
259 | } | |
260 | //end of function | |
261 | ||
262 | /** | |
263 | * Returns total number of rows for the query. | |
264 | * | |
265 | * @param | |
266 | * | |
267 | * @return int Total number of rows | |
268 | * @access public | |
269 | */ | |
270 | function getTotalCount($action) { | |
271 | return $this->_query->searchQuery(0, 0, NULL, | |
272 | TRUE, FALSE, | |
273 | FALSE, FALSE, | |
274 | FALSE, | |
275 | $this->_additionalClause | |
276 | ); | |
277 | } | |
278 | ||
279 | /** | |
280 | * returns all the rows in the given offset and rowCount | |
281 | * | |
282 | * @param enum $action the action being performed | |
283 | * @param int $offset the row number to start from | |
284 | * @param int $rowCount the number of rows to return | |
285 | * @param string $sort the sql string that describes the sort order | |
286 | * @param enum $output what should the result set include (web/email/csv) | |
287 | * | |
288 | * @return int the total number of rows for this action | |
289 | */ | |
290 | function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { | |
291 | $result = $this->_query->searchQuery($offset, $rowCount, $sort, | |
292 | FALSE, FALSE, | |
293 | FALSE, FALSE, | |
294 | FALSE, | |
295 | $this->_additionalClause | |
296 | ); | |
297 | ||
298 | // process the result of the query | |
299 | $rows = array(); | |
300 | ||
301 | // get all pledge status | |
302 | $pledgeStatuses = CRM_Core_OptionGroup::values('contribution_status', | |
303 | FALSE, FALSE, FALSE, NULL, 'name', FALSE | |
304 | ); | |
305 | ||
306 | //get all campaigns. | |
307 | $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE); | |
308 | ||
309 | //4418 check for view, edit and delete | |
310 | $permissions = array(CRM_Core_Permission::VIEW); | |
311 | if (CRM_Core_Permission::check('edit pledges')) { | |
312 | $permissions[] = CRM_Core_Permission::EDIT; | |
313 | } | |
314 | if (CRM_Core_Permission::check('delete in CiviPledge')) { | |
315 | $permissions[] = CRM_Core_Permission::DELETE; | |
316 | } | |
317 | $mask = CRM_Core_Action::mask($permissions); | |
318 | ||
319 | while ($result->fetch()) { | |
320 | $row = array(); | |
321 | // the columns we are interested in | |
322 | foreach (self::$_properties as $property) { | |
323 | if (isset($result->$property)) { | |
324 | $row[$property] = $result->$property; | |
325 | } | |
326 | } | |
327 | ||
328 | //carry campaign on selectors. | |
329 | $row['campaign'] = CRM_Utils_Array::value($result->pledge_campaign_id, $allCampaigns); | |
330 | $row['campaign_id'] = $result->pledge_campaign_id; | |
331 | ||
332 | // add pledge status name | |
333 | $row['pledge_status_name'] = CRM_Utils_Array::value($row['pledge_status_id'], | |
334 | $pledgeStatuses | |
335 | ); | |
336 | // append (test) to status label | |
a7488080 | 337 | if (!empty($row['pledge_is_test'])) { |
6a488035 TO |
338 | $row['pledge_status'] .= ' (test)'; |
339 | } | |
340 | ||
341 | $hideOption = array(); | |
342 | if (CRM_Utils_Array::key('Cancelled', $row) || | |
343 | CRM_Utils_Array::key('Completed', $row) | |
344 | ) { | |
345 | $hideOption[] = 'Cancel'; | |
346 | } | |
347 | ||
348 | $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->pledge_id; | |
349 | ||
350 | $row['action'] = CRM_Core_Action::formLink(self::links($hideOption, $this->_key), | |
351 | $mask, | |
352 | array( | |
353 | 'id' => $result->pledge_id, | |
354 | 'cid' => $result->contact_id, | |
355 | 'cxt' => $this->_context, | |
87dab4a4 AH |
356 | ), |
357 | ts('more'), | |
358 | FALSE, | |
359 | 'pledge.selector.row', | |
360 | 'Pledge', | |
361 | $result->pledge_id | |
6a488035 TO |
362 | ); |
363 | ||
364 | ||
365 | $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? | |
366 | $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id | |
367 | ); | |
368 | $rows[] = $row; | |
369 | } | |
370 | return $rows; | |
371 | } | |
372 | ||
373 | /** | |
374 | * | |
375 | * @return array $qill which contains an array of strings | |
376 | * @access public | |
377 | */ | |
378 | ||
379 | // the current internationalisation is bad, but should more or less work | |
380 | // for most of "European" languages | |
381 | public function getQILL() { | |
382 | return $this->_query->qill(); | |
383 | } | |
384 | ||
385 | /** | |
386 | * returns the column headers as an array of tuples: | |
387 | * (name, sortName (key to the sort array)) | |
388 | * | |
389 | * @param string $action the action being performed | |
390 | * @param enum $output what should the result set include (web/email/csv) | |
391 | * | |
392 | * @return array the column headers that need to be displayed | |
393 | * @access public | |
394 | */ | |
395 | public function &getColumnHeaders($action = NULL, $output = NULL) { | |
396 | if (!isset(self::$_columnHeaders)) { | |
397 | self::$_columnHeaders = array( | |
398 | array( | |
399 | 'name' => ts('Pledged'), | |
400 | 'sort' => 'pledge_amount', | |
401 | 'direction' => CRM_Utils_Sort::DONTCARE, | |
402 | ), | |
403 | array( | |
404 | 'name' => ts('Total Paid'), | |
405 | 'sort' => 'pledge_total_paid', | |
406 | 'direction' => CRM_Utils_Sort::DONTCARE, | |
407 | ), | |
408 | array( | |
409 | 'name' => ts('Balance'), | |
410 | ), | |
411 | array( | |
412 | 'name' => ts('Pledged For'), | |
6d3864ef | 413 | 'sort' => 'pledge_financial_type', |
6a488035 TO |
414 | 'direction' => CRM_Utils_Sort::DONTCARE, |
415 | ), | |
416 | array( | |
417 | 'name' => ts('Pledge Made'), | |
418 | 'sort' => 'pledge_create_date', | |
419 | 'direction' => CRM_Utils_Sort::DESCENDING, | |
420 | ), | |
421 | array( | |
422 | 'name' => ts('Next Pay Date'), | |
423 | 'sort' => 'pledge_next_pay_date', | |
424 | 'direction' => CRM_Utils_Sort::DONTCARE, | |
425 | ), | |
426 | array( | |
427 | 'name' => ts('Next Amount'), | |
428 | 'sort' => 'pledge_next_pay_amount', | |
429 | 'direction' => CRM_Utils_Sort::DONTCARE, | |
430 | ), | |
431 | array( | |
432 | 'name' => ts('Status'), | |
433 | 'sort' => 'pledge_status', | |
434 | 'direction' => CRM_Utils_Sort::DONTCARE, | |
435 | ), | |
436 | array('desc' => ts('Actions')), | |
437 | ); | |
438 | ||
439 | if (!$this->_single) { | |
440 | $pre = array( | |
441 | array('desc' => ts('Contact Id')), | |
442 | array( | |
443 | 'name' => ts('Name'), | |
444 | 'sort' => 'sort_name', | |
445 | 'direction' => CRM_Utils_Sort::DONTCARE, | |
446 | ), | |
447 | ); | |
448 | ||
449 | self::$_columnHeaders = array_merge($pre, self::$_columnHeaders); | |
450 | } | |
451 | } | |
452 | return self::$_columnHeaders; | |
453 | } | |
454 | ||
ffd93213 EM |
455 | /** |
456 | * @return string | |
457 | */ | |
6a488035 TO |
458 | function &getQuery() { |
459 | return $this->_query; | |
460 | } | |
461 | ||
462 | /** | |
463 | * name of export file. | |
464 | * | |
465 | * @param string $output type of output | |
466 | * | |
467 | * @return string name of the file | |
468 | */ | |
469 | function getExportFileName($output = 'csv') { | |
470 | return ts('Pledge Search'); | |
471 | } | |
472 | } | |
473 | //end of class | |
474 |