CRM/Contribute/Selector/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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
  31  * @copyright CiviCRM LLC (c) 2004-2017
  32  */
  33
  34 /**
  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.
  38  *
  39  */
  40 class CRM_Contribute_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
  41
  42   /**
  43    * This defines two actions- View and Edit.
  44    *
  45    * @var array
  46    */
  47   static $_links = NULL;
  48
  49   /**
  50    * We use desc to remind us what that column is, name is used in the tpl
  51    *
  52    * @var array
  53    */
  54   static $_columnHeaders;
  55
  56   /**
  57    * Properties of contact we're interested in displaying
  58    * @var array
  59    */
  60   static $_properties = array(
  61     'contact_id',
  62     'contribution_id',
  63     'contact_type',
  64     'sort_name',
  65     'amount_level',
  66     'total_amount',
  67     'financial_type',
  68     'contribution_source',
  69     'receive_date',
  70     'thankyou_date',
  71     'contribution_status_id',
  72     'contribution_status',
  73     'cancel_date',
  74     'product_name',
  75     'is_test',
  76     'contribution_recur_id',
  77     'receipt_date',
  78     'membership_id',
  79     'currency',
  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',
  85   );
  86
  87   /**
  88    * Are we restricting ourselves to a single contact
  89    *
  90    * @var boolean
  91    */
  92   protected $_single = FALSE;
  93
  94   /**
  95    * Are we restricting ourselves to a single contact
  96    *
  97    * @var boolean
  98    */
  99   protected $_limit = NULL;
 100
 101   /**
 102    * What context are we being invoked from
 103    *
 104    * @var string
 105    */
 106   protected $_context = NULL;
 107
 108   /**
 109    * What component context are we being invoked from
 110    *
 111    * @var string
 112    */
 113   protected $_compContext = NULL;
 114
 115   /**
 116    * QueryParams is the array returned by exportValues called on
 117    * the HTML_QuickForm_Controller for that page.
 118    *
 119    * @var array
 120    */
 121   public $_queryParams;
 122
 123   /**
 124    * Represent the type of selector
 125    *
 126    * @var int
 127    */
 128   protected $_action;
 129
 130   /**
 131    * The additional clause that we restrict the search with
 132    *
 133    * @var string
 134    */
 135   protected $_contributionClause = NULL;
 136
 137   /**
 138    * The query object
 139    *
 140    * @var string
 141    */
 142   protected $_query;
 143
 144   protected $_includeSoftCredits = FALSE;
 145
 146   /**
 147    * Class constructor.
 148    *
 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?.
 156    * @param int $limit
 157    *   How many contributions do we want returned.
 158    *
 159    * @param string $context
 160    * @param null $compContext
 161    *
 162    * @return \CRM_Contribute_Selector_Search
 163    */
 164   public function __construct(
 165     &$queryParams,
 166     $action = CRM_Core_Action::NONE,
 167     $contributionClause = NULL,
 168     $single = FALSE,
 169     $limit = NULL,
 170     $context = 'search',
 171     $compContext = NULL
 172   ) {
 173
 174     // submitted form values
 175     $this->_queryParams = &$queryParams;
 176
 177     $this->_single = $single;
 178     $this->_limit = $limit;
 179     $this->_context = $context;
 180     $this->_compContext = $compContext;
 181
 182     $this->_contributionClause = $contributionClause;
 183
 184     // type of selector
 185     $this->_action = $action;
 186     $returnProperties = CRM_Contribute_BAO_Query::selectorReturnProperties();
 187     $this->_includeSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($this->_queryParams);
 188     $this->_query = new CRM_Contact_BAO_Query(
 189       $this->_queryParams,
 190       $returnProperties,
 191       NULL, FALSE, FALSE,
 192       CRM_Contact_BAO_Query::MODE_CONTRIBUTE
 193     );
 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 ";
 199     }
 200     else {
 201       $this->_query->_distinctComponentClause = " civicrm_contribution.id";
 202       $this->_query->_groupByComponentClause = " GROUP BY civicrm_contribution.id ";
 203     }
 204   }
 205
 206   /**
 207    * This method returns the links that are given for each search row.
 208    * currently the links added for each row are
 209    *
 210    * - View
 211    * - Edit
 212    *
 213    * @param int $componentId
 214    * @param null $componentAction
 215    * @param null $key
 216    * @param null $compContext
 217    *
 218    * @return array
 219    */
 220   public static function &links($componentId = NULL, $componentAction = NULL, $key = NULL, $compContext = NULL) {
 221     $extraParams = NULL;
 222     if ($componentId) {
 223       $extraParams = "&compId={$componentId}&compAction={$componentAction}";
 224     }
 225     if ($compContext) {
 226       $extraParams .= "&compContext={$compContext}";
 227     }
 228     if ($key) {
 229       $extraParams .= "&key={$key}";
 230     }
 231
 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'),
 239         ),
 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'),
 245         ),
 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'),
 251         ),
 252       );
 253     }
 254     return self::$_links;
 255   }
 256
 257   /**
 258    * Getter for array of the parameters required for creating pager.
 259    *
 260    * @param $action
 261    * @param array $params
 262    */
 263   public function getPagerParams($action, &$params) {
 264     $params['status'] = ts('Contribution') . ' %%StatusMessage%%';
 265     $params['csvString'] = NULL;
 266     if ($this->_limit) {
 267       $params['rowCount'] = $this->_limit;
 268     }
 269     else {
 270       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 271     }
 272
 273     $params['buttonTop'] = 'PagerTopButton';
 274     $params['buttonBottom'] = 'PagerBottomButton';
 275   }
 276
 277   /**
 278    * Returns total number of rows for the query.
 279    *
 280    * @param string $action
 281    *
 282    * @return int
 283    *   Total number of rows
 284    */
 285   public function getTotalCount($action) {
 286     return $this->_query->searchQuery(0, 0, NULL,
 287       TRUE, FALSE,
 288       FALSE, FALSE,
 289       FALSE,
 290       $this->_contributionClause
 291     );
 292   }
 293
 294   /**
 295    * Returns all the rows in the given offset and rowCount.
 296    *
 297    * @param string $action
 298    *   The action being performed.
 299    * @param int $offset
 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).
 307    *
 308    * @return int
 309    *   the total number of rows for this action
 310    */
 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";
 315     }
 316     $result = $this->_query->searchQuery($offset, $rowCount, $sort,
 317       FALSE, FALSE,
 318       FALSE, FALSE,
 319       FALSE,
 320       $this->_contributionClause
 321     );
 322     // process the result of the query
 323     $rows = array();
 324
 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;
 329     }
 330     if (CRM_Core_Permission::check('delete in CiviContribute')) {
 331       $permissions[] = CRM_Core_Permission::DELETE;
 332     }
 333     $mask = CRM_Core_Action::mask($permissions);
 334
 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');
 340       $componentId = CRM_Utils_Request::retrieve('id', 'Positive');
 341       $componentAction = CRM_Utils_Request::retrieve('action', 'String');
 342       $componentContext = CRM_Utils_Request::retrieve('compContext', 'String');
 343
 344       if (!$componentContext &&
 345         $this->_compContext
 346       ) {
 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');
 350       }
 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.
 355       if (empty($qfKey)) {
 356         $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', CRM_Core_DAO::$_nullObject, NULL, FALSE, 'REQUEST');
 357       }
 358     }
 359
 360     // get all contribution status
 361     $contributionStatuses = CRM_Core_OptionGroup::values('contribution_status',
 362       FALSE, FALSE, FALSE, NULL, 'name', FALSE
 363     );
 364
 365     //get all campaigns.
 366     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 367
 368     while ($result->fetch()) {
 369       $links = self::links($componentId,
 370           $componentAction,
 371           $qfKey,
 372           $componentContext
 373       );
 374       $checkLineItem = FALSE;
 375       $row = array();
 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;
 382             break;
 383           }
 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]);
 386           }
 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]);
 389           }
 390         }
 391         if ($checkLineItem) {
 392           continue;
 393         }
 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]);
 396         }
 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]);
 399         }
 400       }
 401       // the columns we are interested in
 402       foreach (self::$_properties as $property) {
 403         if (property_exists($result, $property)) {
 404           $row[$property] = $result->$property;
 405         }
 406       }
 407
 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;
 413
 414       // add contribution status name
 415       $row['contribution_status_name'] = CRM_Utils_Array::value($row['contribution_status_id'],
 416         $contributionStatuses
 417       );
 418
 419       $isPayLater = FALSE;
 420       if ($result->is_pay_later && CRM_Utils_Array::value('contribution_status_name', $row) == 'Pending') {
 421         $isPayLater = TRUE;
 422         $row['contribution_status'] .= ' (' . ts('Pay Later') . ')';
 423         $links[CRM_Core_Action::ADD] = array(
 424           'name' => ts('Pay with Credit Card'),
 425           'url' => 'civicrm/contact/view/contribution',
 426           'qs' => 'reset=1&action=update&id=%%id%%&cid=%%cid%%&context=%%cxt%%&mode=live',
 427           'title' => ts('Pay with Credit Card'),
 428         );
 429       }
 430       elseif (CRM_Utils_Array::value('contribution_status_name', $row) == 'Pending') {
 431         $row['contribution_status'] .= ' (' . ts('Incomplete Transaction') . ')';
 432       }
 433
 434       if ($row['is_test']) {
 435         $row['financial_type'] = $row['financial_type'] . ' (' . ts('test') . ')';
 436       }
 437
 438       $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->contribution_id;
 439
 440       $actions = array(
 441         'id' => $result->contribution_id,
 442         'cid' => $result->contact_id,
 443         'cxt' => $this->_context,
 444       );
 445
 446       if (in_array($row['contribution_status_name'], array('Partially paid', 'Pending refund')) || $isPayLater) {
 447         $buttonName = ts('Record Payment');
 448         if ($row['contribution_status_name'] == 'Pending refund') {
 449           $buttonName = ts('Record Refund');
 450         }
 451         $links[CRM_Core_Action::ADD] = array(
 452           'name' => $buttonName,
 453           'url' => 'civicrm/payment',
 454           'qs' => 'reset=1&id=%%id%%&cid=%%cid%%&action=add&component=contribution',
 455           'title' => $buttonName,
 456         );
 457       }
 458
 459       $row['action'] = CRM_Core_Action::formLink(
 460         $links,
 461         $mask, $actions,
 462         ts('more'),
 463         FALSE,
 464         'contribution.selector.row',
 465         'Contribution',
 466         $result->contribution_id
 467       );
 468
 469       $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id
 470       );
 471
 472       if (!empty($row['amount_level'])) {
 473         CRM_Event_BAO_Participant::fixEventLevel($row['amount_level']);
 474       }
 475
 476       $rows[] = $row;
 477     }
 478
 479     return $rows;
 480   }
 481
 482   /**
 483    * @inheritDoc
 484    */
 485   public function getQILL() {
 486     return $this->_query->qill();
 487   }
 488
 489   /**
 490    * Returns the column headers as an array of tuples:
 491    * (name, sortName (key to the sort array))
 492    *
 493    * @param string $action
 494    *   The action being performed.
 495    * @param string $output
 496    *   What should the result set include (web/email/csv).
 497    *
 498    * @return array
 499    *   the column headers that need to be displayed
 500    */
 501   public function &getColumnHeaders($action = NULL, $output = NULL) {
 502     $pre = array();
 503     self::$_columnHeaders = array(
 504       array(
 505         'name' => $this->_includeSoftCredits ? ts('Contribution Amount') : ts('Amount'),
 506         'sort' => 'total_amount',
 507         'direction' => CRM_Utils_Sort::DONTCARE,
 508       ),
 509     );
 510     if ($this->_includeSoftCredits) {
 511       self::$_columnHeaders
 512         = array_merge(
 513           self::$_columnHeaders,
 514           array(
 515             array(
 516               'name' => ts('Soft Credit Amount'),
 517               'sort' => 'contribution_soft_credit_amount',
 518               'direction' => CRM_Utils_Sort::DONTCARE,
 519             ),
 520           )
 521         );
 522     }
 523     self::$_columnHeaders
 524       = array_merge(
 525         self::$_columnHeaders,
 526         array(
 527           array(
 528             'name' => ts('Type'),
 529             'sort' => 'financial_type',
 530             'direction' => CRM_Utils_Sort::DONTCARE,
 531           ),
 532           array(
 533             'name' => ts('Source'),
 534             'sort' => 'contribution_source',
 535             'direction' => CRM_Utils_Sort::DONTCARE,
 536           ),
 537           array(
 538             'name' => ts('Received'),
 539             'sort' => 'receive_date',
 540             'direction' => CRM_Utils_Sort::DESCENDING,
 541           ),
 542           array(
 543             'name' => ts('Thank-you Sent'),
 544             'sort' => 'thankyou_date',
 545             'direction' => CRM_Utils_Sort::DONTCARE,
 546           ),
 547           array(
 548             'name' => ts('Status'),
 549             'sort' => 'contribution_status',
 550             'direction' => CRM_Utils_Sort::DONTCARE,
 551           ),
 552           array(
 553             'name' => ts('Premium'),
 554             'sort' => 'product_name',
 555             'direction' => CRM_Utils_Sort::DONTCARE,
 556           ),
 557         )
 558       );
 559     if (!$this->_single) {
 560       $pre = array(
 561         array(
 562           'name' => ts('Name'),
 563           'sort' => 'sort_name',
 564           'direction' => CRM_Utils_Sort::DONTCARE,
 565         ),
 566       );
 567     }
 568     self::$_columnHeaders = array_merge($pre, self::$_columnHeaders);
 569     if ($this->_includeSoftCredits) {
 570       self::$_columnHeaders = array_merge(
 571         self::$_columnHeaders,
 572         array(
 573           array(
 574             'name' => ts('Soft Credit For'),
 575             'sort' => 'contribution_soft_credit_name',
 576             'direction' => CRM_Utils_Sort::DONTCARE,
 577           ),
 578           array(
 579             'name' => ts('Soft Credit Type'),
 580             'sort' => 'contribution_soft_credit_type',
 581             'direction' => CRM_Utils_Sort::ASCENDING,
 582           ),
 583         )
 584       );
 585     }
 586     self::$_columnHeaders
 587       = array_merge(
 588         self::$_columnHeaders, array(
 589           array('desc' => ts('Actions')),
 590         )
 591       );
 592     CRM_Core_Smarty::singleton()->assign('softCreditColumns', $this->_includeSoftCredits);
 593     return self::$_columnHeaders;
 594   }
 595
 596   /**
 597    * @return mixed
 598    */
 599   public function alphabetQuery() {
 600     return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
 601   }
 602
 603   /**
 604    * @return string
 605    */
 606   public function &getQuery() {
 607     return $this->_query;
 608   }
 609
 610   /**
 611    * Name of export file.
 612    *
 613    * @param string $output
 614    *   Type of output.
 615    *
 616    * @return string
 617    *   name of the file
 618    */
 619   public function getExportFileName($output = 'csv') {
 620     return ts('CiviCRM Contribution Search');
 621   }
 622
 623   /**
 624    * @return mixed
 625    */
 626   public function getSummary() {
 627     return $this->_query->summaryContribution($this->_context);
 628   }
 629
 630 }