3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2016
35 * This class is used to retrieve and display a range of
36 * contacts that match the given criteria (specifically for
37 * results of advanced search options.
40 class CRM_Contribute_Selector_Search
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
43 * This defines two actions- View and Edit.
47 static $_links = NULL;
50 * We use desc to remind us what that column is, name is used in the tpl
54 static $_columnHeaders;
57 * Properties of contact we're interested in displaying
60 static $_properties = array(
68 'contribution_source',
71 'contribution_status_id',
72 'contribution_status',
76 'contribution_recur_id',
80 'contribution_campaign_id',
81 'contribution_soft_credit_name',
82 'contribution_soft_credit_contact_id',
83 'contribution_soft_credit_amount',
84 'contribution_soft_credit_type',
88 * Are we restricting ourselves to a single contact
92 protected $_single = FALSE;
95 * Are we restricting ourselves to a single contact
99 protected $_limit = NULL;
102 * What context are we being invoked from
106 protected $_context = NULL;
109 * What component context are we being invoked from
113 protected $_compContext = NULL;
116 * QueryParams is the array returned by exportValues called on
117 * the HTML_QuickForm_Controller for that page.
121 public $_queryParams;
124 * Represent the type of selector
131 * The additional clause that we restrict the search with
135 protected $_contributionClause = NULL;
144 protected $_includeSoftCredits = FALSE;
149 * @param array $queryParams
150 * Array of parameters for query.
151 * @param \const|int $action - action of search basic or advanced.
152 * @param string $contributionClause
153 * If the caller wants to further restrict the search (used in contributions).
154 * @param bool $single
155 * Are we dealing only with one contact?.
157 * How many contributions do we want returned.
159 * @param string $context
160 * @param null $compContext
162 * @return \CRM_Contribute_Selector_Search
164 public function __construct(
166 $action = CRM_Core_Action
::NONE
,
167 $contributionClause = NULL,
174 // submitted form values
175 $this->_queryParams
= &$queryParams;
177 $this->_single
= $single;
178 $this->_limit
= $limit;
179 $this->_context
= $context;
180 $this->_compContext
= $compContext;
182 $this->_contributionClause
= $contributionClause;
185 $this->_action
= $action;
187 $this->_includeSoftCredits
= CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled($this->_queryParams
);
188 $this->_query
= new CRM_Contact_BAO_Query(
190 CRM_Contribute_BAO_Query
::selectorReturnProperties(),
192 CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
194 // @todo the function CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled should handle this
195 // can we remove? if not why not?
196 if ($this->_includeSoftCredits
) {
197 $this->_query
->_rowCountClause
= " count(civicrm_contribution.id)";
198 $this->_query
->_groupByComponentClause
= " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
201 $this->_query
->_distinctComponentClause
= " civicrm_contribution.id";
202 $this->_query
->_groupByComponentClause
= " GROUP BY civicrm_contribution.id ";
207 * This method returns the links that are given for each search row.
208 * currently the links added for each row are
213 * @param int $componentId
214 * @param null $componentAction
216 * @param null $compContext
220 public static function &links($componentId = NULL, $componentAction = NULL, $key = NULL, $compContext = NULL) {
223 $extraParams = "&compId={$componentId}&compAction={$componentAction}";
226 $extraParams .= "&compContext={$compContext}";
229 $extraParams .= "&key={$key}";
232 if (!(self
::$_links)) {
233 self
::$_links = array(
234 CRM_Core_Action
::VIEW
=> array(
235 'name' => ts('View'),
236 'url' => 'civicrm/contact/view/contribution',
237 'qs' => "reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=contribute{$extraParams}",
238 'title' => ts('View Contribution'),
240 CRM_Core_Action
::UPDATE
=> array(
241 'name' => ts('Edit'),
242 'url' => 'civicrm/contact/view/contribution',
243 'qs' => "reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%{$extraParams}",
244 'title' => ts('Edit Contribution'),
246 CRM_Core_Action
::DELETE
=> array(
247 'name' => ts('Delete'),
248 'url' => 'civicrm/contact/view/contribution',
249 'qs' => "reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%{$extraParams}",
250 'title' => ts('Delete Contribution'),
254 return self
::$_links;
258 * Getter for array of the parameters required for creating pager.
261 * @param array $params
263 public function getPagerParams($action, &$params) {
264 $params['status'] = ts('Contribution') . ' %%StatusMessage%%';
265 $params['csvString'] = NULL;
267 $params['rowCount'] = $this->_limit
;
270 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
273 $params['buttonTop'] = 'PagerTopButton';
274 $params['buttonBottom'] = 'PagerBottomButton';
278 * Returns total number of rows for the query.
280 * @param string $action
283 * Total number of rows
285 public function getTotalCount($action) {
286 return $this->_query
->searchQuery(0, 0, NULL,
290 $this->_contributionClause
295 * Returns all the rows in the given offset and rowCount.
297 * @param string $action
298 * The action being performed.
300 * The row number to start from.
301 * @param int $rowCount
302 * The number of rows to return.
303 * @param string $sort
304 * The sql string that describes the sort order.
305 * @param string $output
306 * What should the result set include (web/email/csv).
309 * the total number of rows for this action
311 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
312 if ($this->_includeSoftCredits
) {
313 // especial sort order when rows include soft credits
314 $sort = $sort->orderBy() . ", civicrm_contribution.id, civicrm_contribution_soft.id";
316 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
320 $this->_contributionClause
322 // process the result of the query
325 //CRM-4418 check for view/edit/delete
326 $permissions = array(CRM_Core_Permission
::VIEW
);
327 if (CRM_Core_Permission
::check('edit contributions')) {
328 $permissions[] = CRM_Core_Permission
::EDIT
;
330 if (CRM_Core_Permission
::check('delete in CiviContribute')) {
331 $permissions[] = CRM_Core_Permission
::DELETE
;
333 $mask = CRM_Core_Action
::mask($permissions);
335 $qfKey = $this->_key
;
336 $componentId = $componentContext = NULL;
337 if ($this->_context
!= 'contribute') {
338 // @todo explain the significance of context & why we do not get these i that context.
339 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', CRM_Core_DAO
::$_nullObject);
340 $componentId = CRM_Utils_Request
::retrieve('id', 'Positive', CRM_Core_DAO
::$_nullObject);
341 $componentAction = CRM_Utils_Request
::retrieve('action', 'String', CRM_Core_DAO
::$_nullObject);
342 $componentContext = CRM_Utils_Request
::retrieve('compContext', 'String', CRM_Core_DAO
::$_nullObject);
344 if (!$componentContext &&
347 // @todo explain when this condition might occur.
348 $componentContext = $this->_compContext
;
349 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', CRM_Core_DAO
::$_nullObject, NULL, FALSE, 'REQUEST');
351 // CRM-17628 for some reason qfKey is not always set when searching from contribution search.
352 // as a result if the edit link is opened using right-click + open in new tab
353 // then the browser is not returned to the search results on save.
354 // This is an effort to getting the qfKey without, sadly, understanding the intent of those who came before me.
356 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', CRM_Core_DAO
::$_nullObject, NULL, FALSE, 'REQUEST');
360 // get all contribution status
361 $contributionStatuses = CRM_Core_OptionGroup
::values('contribution_status',
362 FALSE, FALSE, FALSE, NULL, 'name', FALSE
366 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
368 while ($result->fetch()) {
369 $links = self
::links($componentId,
374 $checkLineItem = FALSE;
376 // Now check for lineItems
377 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
378 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($result->id
);
379 foreach ($lineItems as $items) {
380 if (!CRM_Core_Permission
::check('view contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($items['financial_type_id']))) {
381 $checkLineItem = TRUE;
384 if (!CRM_Core_Permission
::check('edit contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($items['financial_type_id']))) {
385 unset($links[CRM_Core_Action
::UPDATE
]);
387 if (!CRM_Core_Permission
::check('delete contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($items['financial_type_id']))) {
388 unset($links[CRM_Core_Action
::DELETE
]);
391 if ($checkLineItem) {
394 if (!CRM_Core_Permission
::check('edit contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($result->financial_type_id
))) {
395 unset($links[CRM_Core_Action
::UPDATE
]);
397 if (!CRM_Core_Permission
::check('delete contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($result->financial_type_id
))) {
398 unset($links[CRM_Core_Action
::DELETE
]);
401 // the columns we are interested in
402 foreach (self
::$_properties as $property) {
403 if (property_exists($result, $property)) {
404 $row[$property] = $result->$property;
408 //carry campaign on selectors.
409 // @todo - I can't find any evidence that 'carrying' the campaign on selectors actually
410 // results in it being displayed anywhere so why do we do this???
411 $row['campaign'] = CRM_Utils_Array
::value($result->contribution_campaign_id
, $allCampaigns);
412 $row['campaign_id'] = $result->contribution_campaign_id
;
414 // add contribution status name
415 $row['contribution_status_name'] = CRM_Utils_Array
::value($row['contribution_status_id'],
416 $contributionStatuses
419 if ($result->is_pay_later
&& CRM_Utils_Array
::value('contribution_status_name', $row) == 'Pending') {
420 $row['contribution_status'] .= ' (' . ts('Pay Later') . ')';
421 $links[CRM_Core_Action
::ADD
] = array(
422 'name' => ts('Pay with Credit Card'),
423 'url' => 'civicrm/contact/view/contribution',
424 'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%&mode=live',
425 'title' => ts('Pay with Credit Card'),
428 elseif (CRM_Utils_Array
::value('contribution_status_name', $row) == 'Pending') {
429 $row['contribution_status'] .= ' (' . ts('Incomplete Transaction') . ')';
432 if ($row['is_test']) {
433 $row['financial_type'] = $row['financial_type'] . ' (' . ts('test') . ')';
436 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->contribution_id
;
439 'id' => $result->contribution_id
,
440 'cid' => $result->contact_id
,
441 'cxt' => $this->_context
,
444 $row['action'] = CRM_Core_Action
::formLink(
449 'contribution.selector.row',
451 $result->contribution_id
454 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
457 if (!empty($row['amount_level'])) {
458 CRM_Event_BAO_Participant
::fixEventLevel($row['amount_level']);
470 public function getQILL() {
471 return $this->_query
->qill();
475 * Returns the column headers as an array of tuples:
476 * (name, sortName (key to the sort array))
478 * @param string $action
479 * The action being performed.
480 * @param string $output
481 * What should the result set include (web/email/csv).
484 * the column headers that need to be displayed
486 public function &getColumnHeaders($action = NULL, $output = NULL) {
488 self
::$_columnHeaders = array(
490 'name' => $this->_includeSoftCredits ?
ts('Contribution Amount') : ts('Amount'),
491 'sort' => 'total_amount',
492 'direction' => CRM_Utils_Sort
::DONTCARE
,
495 if ($this->_includeSoftCredits
) {
496 self
::$_columnHeaders
498 self
::$_columnHeaders,
501 'name' => ts('Soft Credit Amount'),
502 'sort' => 'contribution_soft_credit_amount',
503 'direction' => CRM_Utils_Sort
::DONTCARE
,
508 self
::$_columnHeaders
510 self
::$_columnHeaders,
513 'name' => ts('Type'),
514 'sort' => 'financial_type',
515 'direction' => CRM_Utils_Sort
::DONTCARE
,
518 'name' => ts('Source'),
519 'sort' => 'contribution_source',
520 'direction' => CRM_Utils_Sort
::DONTCARE
,
523 'name' => ts('Received'),
524 'sort' => 'receive_date',
525 'direction' => CRM_Utils_Sort
::DESCENDING
,
528 'name' => ts('Thank-you Sent'),
529 'sort' => 'thankyou_date',
530 'direction' => CRM_Utils_Sort
::DONTCARE
,
533 'name' => ts('Status'),
534 'sort' => 'contribution_status',
535 'direction' => CRM_Utils_Sort
::DONTCARE
,
538 'name' => ts('Premium'),
539 'sort' => 'product_name',
540 'direction' => CRM_Utils_Sort
::DONTCARE
,
544 if (!$this->_single
) {
547 'name' => ts('Name'),
548 'sort' => 'sort_name',
549 'direction' => CRM_Utils_Sort
::DONTCARE
,
553 self
::$_columnHeaders = array_merge($pre, self
::$_columnHeaders);
554 if ($this->_includeSoftCredits
) {
555 self
::$_columnHeaders = array_merge(
556 self
::$_columnHeaders,
559 'name' => ts('Soft Credit For'),
560 'sort' => 'contribution_soft_credit_name',
561 'direction' => CRM_Utils_Sort
::DONTCARE
,
564 'name' => ts('Soft Credit Type'),
565 'sort' => 'contribution_soft_credit_type',
566 'direction' => CRM_Utils_Sort
::ASCENDING
,
571 self
::$_columnHeaders
573 self
::$_columnHeaders, array(
574 array('desc' => ts('Actions')),
577 CRM_Core_Smarty
::singleton()->assign('softCreditColumns', $this->_includeSoftCredits
);
578 return self
::$_columnHeaders;
584 public function alphabetQuery() {
585 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
591 public function &getQuery() {
592 return $this->_query
;
596 * Name of export file.
598 * @param string $output
604 public function getExportFileName($output = 'csv') {
605 return ts('CiviCRM Contribution Search');
611 public function getSummary() {
612 return $this->_query
->summaryContribution($this->_context
);