3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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.
42 class CRM_Contribute_Selector_Search
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
45 * This defines two actions- View and Edit.
50 static $_links = NULL;
53 * We use desc to remind us what that column is, name is used in the tpl
58 static $_columnHeaders;
61 * Properties of contact we're interested in displaying
65 static $_properties = array(
73 'contribution_source',
76 'contribution_status_id',
77 'contribution_status',
81 'contribution_recur_id',
85 'contribution_campaign_id',
86 'contribution_soft_credit_name',
87 'contribution_soft_credit_contact_id',
88 'contribution_soft_credit_amount',
89 'contribution_soft_credit_type',
93 * Are we restricting ourselves to a single contact
97 protected $_single = FALSE;
100 * Are we restricting ourselves to a single contact
104 protected $_limit = NULL;
107 * What context are we being invoked from
111 protected $_context = NULL;
114 * What component context are we being invoked from
118 protected $_compContext = NULL;
121 * QueryParams is the array returned by exportValues called on
122 * the HTML_QuickForm_Controller for that page.
126 public $_queryParams;
129 * Represent the type of selector
136 * The additional clause that we restrict the search with
140 protected $_contributionClause = NULL;
149 protected $_includeSoftCredits = FALSE;
154 * @param array $queryParams array of parameters for query
155 * @param \const|int $action - action of search basic or advanced.
156 * @param string $contributionClause if the caller wants to further restrict the search (used in contributions)
157 * @param boolean $single are we dealing only with one contact?
158 * @param int $limit how many contributions do we want returned
160 * @param string $context
161 * @param null $compContext
163 * @return \CRM_Contribute_Selector_Search
166 function __construct(&$queryParams,
167 $action = CRM_Core_Action
::NONE
,
168 $contributionClause = NULL,
175 // submitted form values
176 $this->_queryParams
= &$queryParams;
178 $this->_single
= $single;
179 $this->_limit
= $limit;
180 $this->_context
= $context;
181 $this->_compContext
= $compContext;
183 $this->_contributionClause
= $contributionClause;
186 $this->_action
= $action;
188 $this->_includeSoftCredits
= CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled($this->_queryParams
);
189 $this->_query
= new CRM_Contact_BAO_Query(
191 CRM_Contribute_BAO_Query
::defaultReturnProperties(
192 CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
,
196 CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
198 if ($this->_includeSoftCredits
) {
199 $this->_query
->_rowCountClause
= " count(civicrm_contribution.id)";
200 $this->_query
->_groupByComponentClause
= " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
202 $this->_query
->_distinctComponentClause
= " civicrm_contribution.id";
203 $this->_query
->_groupByComponentClause
= " GROUP BY civicrm_contribution.id ";
208 * This method returns the links that are given for each search row.
209 * currently the links added for each row are
214 * @param int $componentId
215 * @param null $componentAction
217 * @param null $compContext
221 public static function &links($componentId = NULL, $componentAction = NULL, $key = NULL, $compContext = NULL) {
224 $extraParams = "&compId={$componentId}&compAction={$componentAction}";
227 $extraParams .= "&compContext={$compContext}";
230 $extraParams .= "&key={$key}";
233 if (!(self
::$_links)) {
234 self
::$_links = array(
235 CRM_Core_Action
::VIEW
=> array(
236 'name' => ts('View'),
237 'url' => 'civicrm/contact/view/contribution',
238 'qs' => "reset=1&id=%%id%%&cid=%%cid%%&action=view&context=%%cxt%%&selectedChild=contribute{$extraParams}",
239 'title' => ts('View Contribution'),
241 CRM_Core_Action
::UPDATE
=> array(
242 'name' => ts('Edit'),
243 'url' => 'civicrm/contact/view/contribution',
244 'qs' => "reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%{$extraParams}",
245 'title' => ts('Edit Contribution'),
247 CRM_Core_Action
::DELETE
=> array(
248 'name' => ts('Delete'),
249 'url' => 'civicrm/contact/view/contribution',
250 'qs' => "reset=1&action=delete&id=%%id%%&cid=%%cid%%&context=%%cxt%%{$extraParams}",
251 'title' => ts('Delete Contribution'),
255 return self
::$_links;
259 * Getter for array of the parameters required for creating pager.
262 * @param array $params
264 public function getPagerParams($action, &$params) {
265 $params['status'] = ts('Contribution') . ' %%StatusMessage%%';
266 $params['csvString'] = NULL;
268 $params['rowCount'] = $this->_limit
;
271 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
274 $params['buttonTop'] = 'PagerTopButton';
275 $params['buttonBottom'] = 'PagerBottomButton';
279 * Returns total number of rows for the query.
283 * @return int 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 enum $action the action being performed
298 * @param int $offset the row number to start from
299 * @param int $rowCount the number of rows to return
300 * @param string $sort the sql string that describes the sort order
301 * @param enum $output what should the result set include (web/email/csv)
303 * @return int the total number of rows for this action
305 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
306 if ($this->_includeSoftCredits
) {
307 // especial sort order when rows include soft credits
308 $sort = "civicrm_contribution.receive_date DESC, civicrm_contribution.id, civicrm_contribution_soft.id";
310 $result = $this->_query
->searchQuery($offset, $rowCount, $sort,
314 $this->_contributionClause
316 // process the result of the query
319 //CRM-4418 check for view/edit/delete
320 $permissions = array(CRM_Core_Permission
::VIEW
);
321 if (CRM_Core_Permission
::check('edit contributions')) {
322 $permissions[] = CRM_Core_Permission
::EDIT
;
324 if (CRM_Core_Permission
::check('delete in CiviContribute')) {
325 $permissions[] = CRM_Core_Permission
::DELETE
;
327 $mask = CRM_Core_Action
::mask($permissions);
329 $qfKey = $this->_key
;
330 $componentId = $componentContext = NULL;
331 if ($this->_context
!= 'contribute') {
332 $qfKey = CRM_Utils_Request
::retrieve('key', 'String', CRM_Core_DAO
::$_nullObject);
333 $componentId = CRM_Utils_Request
::retrieve('id', 'Positive', CRM_Core_DAO
::$_nullObject);
334 $componentAction = CRM_Utils_Request
::retrieve('action', 'String', CRM_Core_DAO
::$_nullObject);
335 $componentContext = CRM_Utils_Request
::retrieve('compContext', 'String', CRM_Core_DAO
::$_nullObject);
337 if (!$componentContext &&
340 $componentContext = $this->_compContext
;
341 $qfKey = CRM_Utils_Request
::retrieve('qfKey', 'String', CRM_Core_DAO
::$_nullObject, NULL, FALSE, 'REQUEST');
345 // get all contribution status
346 $contributionStatuses = CRM_Core_OptionGroup
::values('contribution_status',
347 FALSE, FALSE, FALSE, NULL, 'name', FALSE
351 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
353 While ($result->fetch()) {
355 // the columns we are interested in
356 foreach (self
::$_properties as $property) {
357 if (property_exists($result, $property)) {
358 $row[$property] = $result->$property;
362 //carry campaign on selectors.
363 $row['campaign'] = CRM_Utils_Array
::value($result->contribution_campaign_id
, $allCampaigns);
364 $row['campaign_id'] = $result->contribution_campaign_id
;
366 // add contribution status name
367 $row['contribution_status_name'] = CRM_Utils_Array
::value($row['contribution_status_id'],
368 $contributionStatuses
371 if ($result->is_pay_later
&& CRM_Utils_Array
::value('contribution_status_name', $row) == 'Pending') {
372 $row['contribution_status'] .= ' (' . ts('Pay Later') . ')';
374 elseif (CRM_Utils_Array
::value('contribution_status_name', $row) == 'Pending') {
375 $row['contribution_status'] .= ' (' . ts('Incomplete Transaction') . ')';
378 if ($row['is_test']) {
379 $row['financial_type'] = $row['financial_type'] . ' (' . ts('test') . ')';
382 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->contribution_id
;
385 'id' => $result->contribution_id
,
386 'cid' => $result->contact_id
,
387 'cxt' => $this->_context
,
390 $row['action'] = CRM_Core_Action
::formLink(
391 self
::links($componentId,
399 'contribution.selector.row',
401 $result->contribution_id
404 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
405 $result->contact_sub_type
: $result->contact_type
, FALSE, $result->contact_id
408 if (!empty($row['amount_level'])) {
409 CRM_Event_BAO_Participant
::fixEventLevel($row['amount_level']);
419 * @return array $qill which contains an array of strings
422 // the current internationalisation is bad, but should more or less work
423 // for most of "European" languages
424 public function getQILL() {
425 return $this->_query
->qill();
429 * Returns the column headers as an array of tuples:
430 * (name, sortName (key to the sort array))
432 * @param string $action the action being performed
433 * @param enum $output what should the result set include (web/email/csv)
435 * @return array the column headers that need to be displayed
437 public function &getColumnHeaders($action = NULL, $output = NULL) {
438 self
::$_columnHeaders = array(
440 'name' => $this->_includeSoftCredits ?
ts('Contribution Amount') : ts('Amount'),
441 'sort' => 'total_amount',
442 'direction' => CRM_Utils_Sort
::DONTCARE
,
445 if ($this->_includeSoftCredits
) {
446 self
::$_columnHeaders =
448 self
::$_columnHeaders,
451 'name' => ts('Soft Credit Amount'),
452 'sort' => 'contribution_soft_credit_amount',
453 'direction' => CRM_Utils_Sort
::DONTCARE
,
458 self
::$_columnHeaders =
460 self
::$_columnHeaders,
463 'name' => ts('Type'),
464 'sort' => 'financial_type',
465 'direction' => CRM_Utils_Sort
::DONTCARE
,
468 'name' => ts('Source'),
469 'sort' => 'contribution_source',
470 'direction' => CRM_Utils_Sort
::DONTCARE
,
473 'name' => ts('Received'),
474 'sort' => 'receive_date',
475 'direction' => CRM_Utils_Sort
::DESCENDING
,
478 'name' => ts('Thank-you Sent'),
479 'sort' => 'thankyou_date',
480 'direction' => CRM_Utils_Sort
::DONTCARE
,
483 'name' => ts('Status'),
484 'sort' => 'contribution_status',
485 'direction' => CRM_Utils_Sort
::DONTCARE
,
488 'name' => ts('Premium'),
489 'sort' => 'product_name',
490 'direction' => CRM_Utils_Sort
::DONTCARE
,
494 if (!$this->_single
) {
496 array('desc' => ts('Contact Type')),
498 'name' => ts('Name'),
499 'sort' => 'sort_name',
500 'direction' => CRM_Utils_Sort
::DONTCARE
,
503 self
::$_columnHeaders = array_merge($pre, self
::$_columnHeaders);
505 if ($this->_includeSoftCredits
) {
506 self
::$_columnHeaders =
508 self
::$_columnHeaders,
511 'name' => ts('Soft Credit For'),
512 'sort' => 'contribution_soft_credit_name',
513 'direction' => CRM_Utils_Sort
::DONTCARE
,
516 'name' => ts('Soft Credit Type'),
517 'sort' => 'contribution_soft_credit_type',
518 'direction' => CRM_Utils_Sort
::ASCENDING
,
523 self
::$_columnHeaders =
525 self
::$_columnHeaders, array(
526 array('desc' => ts('Actions'))
529 return self
::$_columnHeaders;
535 public function alphabetQuery() {
536 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
542 public function &getQuery() {
543 return $this->_query
;
547 * Name of export file.
549 * @param string $output type of output
551 * @return string name of the file
553 public function getExportFileName($output = 'csv') {
554 return ts('CiviCRM Contribution Search');
560 public function getSummary() {
561 return $this->_query
->summaryContribution($this->_context
);