CRM/Contribute/Selector/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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
 187     $this->_includeSoftCredits = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($this->_queryParams);
 188     $this->_query = new CRM_Contact_BAO_Query(
 189       $this->_queryParams,
 190       CRM_Contribute_BAO_Query::defaultReturnProperties(
 191         CRM_Contact_BAO_Query::MODE_CONTRIBUTE,
 192         FALSE
 193       ),
 194       NULL, FALSE, FALSE,
 195       CRM_Contact_BAO_Query::MODE_CONTRIBUTE
 196     );
 197     if ($this->_includeSoftCredits) {
 198       $this->_query->_rowCountClause = " count(civicrm_contribution.id)";
 199       $this->_query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
 200     }
 201     else {
 202       $this->_query->_distinctComponentClause = " civicrm_contribution.id";
 203       $this->_query->_groupByComponentClause = " GROUP BY civicrm_contribution.id ";
 204     }
 205   }
 206
 207   /**
 208    * This method returns the links that are given for each search row.
 209    * currently the links added for each row are
 210    *
 211    * - View
 212    * - Edit
 213    *
 214    * @param int $componentId
 215    * @param null $componentAction
 216    * @param null $key
 217    * @param null $compContext
 218    *
 219    * @return array
 220    */
 221   public static function &links($componentId = NULL, $componentAction = NULL, $key = NULL, $compContext = NULL) {
 222     $extraParams = NULL;
 223     if ($componentId) {
 224       $extraParams = "&compId={$componentId}&compAction={$componentAction}";
 225     }
 226     if ($compContext) {
 227       $extraParams .= "&compContext={$compContext}";
 228     }
 229     if ($key) {
 230       $extraParams .= "&key={$key}";
 231     }
 232
 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'),
 240         ),
 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'),
 246         ),
 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'),
 252         ),
 253       );
 254     }
 255     return self::$_links;
 256   }
 257
 258   /**
 259    * Getter for array of the parameters required for creating pager.
 260    *
 261    * @param $action
 262    * @param array $params
 263    */
 264   public function getPagerParams($action, &$params) {
 265     $params['status'] = ts('Contribution') . ' %%StatusMessage%%';
 266     $params['csvString'] = NULL;
 267     if ($this->_limit) {
 268       $params['rowCount'] = $this->_limit;
 269     }
 270     else {
 271       $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
 272     }
 273
 274     $params['buttonTop'] = 'PagerTopButton';
 275     $params['buttonBottom'] = 'PagerBottomButton';
 276   }
 277
 278   /**
 279    * Returns total number of rows for the query.
 280    *
 281    * @param string $action
 282    *
 283    * @return int
 284    *   Total number of rows
 285    */
 286   public function getTotalCount($action) {
 287     return $this->_query->searchQuery(0, 0, NULL,
 288       TRUE, FALSE,
 289       FALSE, FALSE,
 290       FALSE,
 291       $this->_contributionClause
 292     );
 293   }
 294
 295   /**
 296    * Returns all the rows in the given offset and rowCount.
 297    *
 298    * @param string $action
 299    *   The action being performed.
 300    * @param int $offset
 301    *   The row number to start from.
 302    * @param int $rowCount
 303    *   The number of rows to return.
 304    * @param string $sort
 305    *   The sql string that describes the sort order.
 306    * @param string $output
 307    *   What should the result set include (web/email/csv).
 308    *
 309    * @return int
 310    *   the total number of rows for this action
 311    */
 312   public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
 313     if ($this->_includeSoftCredits) {
 314       // especial sort order when rows include soft credits
 315       $sort = "civicrm_contribution.receive_date DESC, civicrm_contribution.id, civicrm_contribution_soft.id";
 316     }
 317     $result = $this->_query->searchQuery($offset, $rowCount, $sort,
 318       FALSE, FALSE,
 319       FALSE, FALSE,
 320       FALSE,
 321       $this->_contributionClause
 322     );
 323     // process the result of the query
 324     $rows = array();
 325
 326     //CRM-4418 check for view/edit/delete
 327     $permissions = array(CRM_Core_Permission::VIEW);
 328     if (CRM_Core_Permission::check('edit contributions')) {
 329       $permissions[] = CRM_Core_Permission::EDIT;
 330     }
 331     if (CRM_Core_Permission::check('delete in CiviContribute')) {
 332       $permissions[] = CRM_Core_Permission::DELETE;
 333     }
 334     $mask = CRM_Core_Action::mask($permissions);
 335
 336     $qfKey = $this->_key;
 337     $componentId = $componentContext = NULL;
 338     if ($this->_context != 'contribute') {
 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);
 343
 344       if (!$componentContext &&
 345         $this->_compContext
 346       ) {
 347         $componentContext = $this->_compContext;
 348         $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', CRM_Core_DAO::$_nullObject, NULL, FALSE, 'REQUEST');
 349       }
 350     }
 351
 352     // get all contribution status
 353     $contributionStatuses = CRM_Core_OptionGroup::values('contribution_status',
 354       FALSE, FALSE, FALSE, NULL, 'name', FALSE
 355     );
 356
 357     //get all campaigns.
 358     $allCampaigns = CRM_Campaign_BAO_Campaign::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
 359
 360     while ($result->fetch()) {
 361       $links = self::links($componentId,
 362           $componentAction,
 363           $qfKey,
 364           $componentContext
 365       );
 366       $checkLineItem = FALSE;
 367       $row = array();
 368       if (!CRM_Core_Permission::check('view contributions of type ' . CRM_Contribute_PseudoConstant::financialType($result->financial_type_id))) {
 369         continue;
 370       }
 371       // Now check for lineItems
 372       $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($result->id);
 373       foreach ($lineItems as $items) {
 374         if (!CRM_Core_Permission::check('view contributions of type ' . CRM_Contribute_PseudoConstant::financialType($items['financial_type_id']))) {
 375           $checkLineItem = TRUE;
 376           break;
 377         }
 378         if (!CRM_Core_Permission::check('edit contributions of type ' . CRM_Contribute_PseudoConstant::financialType($items['financial_type_id']))) {
 379           unset($links[CRM_Core_Action::UPDATE]);
 380           break;
 381         }
 382         if (!CRM_Core_Permission::check('delete contributions of type ' . CRM_Contribute_PseudoConstant::financialType($items['financial_type_id']))) {
 383           unset($links[CRM_Core_Action::DELETE]);
 384           break;
 385         }
 386       }
 387       if ($checkLineItem) {
 388         continue;
 389       }
 390       if (!CRM_Core_Permission::check('edit contributions of type ' . CRM_Contribute_PseudoConstant::financialType($result->financial_type_id))) {
 391         unset($links[2]);
 392       }
 393       if (!CRM_Core_Permission::check('delete contributions of type ' . CRM_Contribute_PseudoConstant::financialType($result->financial_type_id))) {
 394         unset($links[8]);
 395       }
 396       // the columns we are interested in
 397       foreach (self::$_properties as $property) {
 398         if (property_exists($result, $property)) {
 399           $row[$property] = $result->$property;
 400         }
 401       }
 402
 403       //carry campaign on selectors.
 404       $row['campaign'] = CRM_Utils_Array::value($result->contribution_campaign_id, $allCampaigns);
 405       $row['campaign_id'] = $result->contribution_campaign_id;
 406
 407       // add contribution status name
 408       $row['contribution_status_name'] = CRM_Utils_Array::value($row['contribution_status_id'],
 409         $contributionStatuses
 410       );
 411
 412       if ($result->is_pay_later && CRM_Utils_Array::value('contribution_status_name', $row) == 'Pending') {
 413         $row['contribution_status'] .= ' (' . ts('Pay Later') . ')';
 414       }
 415       elseif (CRM_Utils_Array::value('contribution_status_name', $row) == 'Pending') {
 416         $row['contribution_status'] .= ' (' . ts('Incomplete Transaction') . ')';
 417       }
 418
 419       if ($row['is_test']) {
 420         $row['financial_type'] = $row['financial_type'] . ' (' . ts('test') . ')';
 421       }
 422
 423       $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->contribution_id;
 424
 425       $actions = array(
 426         'id' => $result->contribution_id,
 427         'cid' => $result->contact_id,
 428         'cxt' => $this->_context,
 429       );
 430
 431       $row['action'] = CRM_Core_Action::formLink(
 432         $links,
 433         $mask, $actions,
 434         ts('more'),
 435         FALSE,
 436         'contribution.selector.row',
 437         'Contribution',
 438         $result->contribution_id
 439       );
 440
 441       $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id
 442       );
 443
 444       if (!empty($row['amount_level'])) {
 445         CRM_Event_BAO_Participant::fixEventLevel($row['amount_level']);
 446       }
 447
 448       $rows[] = $row;
 449     }
 450
 451     return $rows;
 452   }
 453
 454   /**
 455    * @inheritDoc
 456    */
 457   public function getQILL() {
 458     return $this->_query->qill();
 459   }
 460
 461   /**
 462    * Returns the column headers as an array of tuples:
 463    * (name, sortName (key to the sort array))
 464    *
 465    * @param string $action
 466    *   The action being performed.
 467    * @param string $output
 468    *   What should the result set include (web/email/csv).
 469    *
 470    * @return array
 471    *   the column headers that need to be displayed
 472    */
 473   public function &getColumnHeaders($action = NULL, $output = NULL) {
 474     self::$_columnHeaders = array(
 475       array(
 476         'name' => $this->_includeSoftCredits ? ts('Contribution Amount') : ts('Amount'),
 477         'sort' => 'total_amount',
 478         'direction' => CRM_Utils_Sort::DONTCARE,
 479       ),
 480     );
 481     if ($this->_includeSoftCredits) {
 482       self::$_columnHeaders
 483         = array_merge(
 484           self::$_columnHeaders,
 485           array(
 486             array(
 487               'name' => ts('Soft Credit Amount'),
 488               'sort' => 'contribution_soft_credit_amount',
 489               'direction' => CRM_Utils_Sort::DONTCARE,
 490             ),
 491           )
 492         );
 493     }
 494     self::$_columnHeaders
 495       = array_merge(
 496         self::$_columnHeaders,
 497         array(
 498           array(
 499             'name' => ts('Type'),
 500             'sort' => 'financial_type',
 501             'direction' => CRM_Utils_Sort::DONTCARE,
 502           ),
 503           array(
 504             'name' => ts('Source'),
 505             'sort' => 'contribution_source',
 506             'direction' => CRM_Utils_Sort::DONTCARE,
 507           ),
 508           array(
 509             'name' => ts('Received'),
 510             'sort' => 'receive_date',
 511             'direction' => CRM_Utils_Sort::DESCENDING,
 512           ),
 513           array(
 514             'name' => ts('Thank-you Sent'),
 515             'sort' => 'thankyou_date',
 516             'direction' => CRM_Utils_Sort::DONTCARE,
 517           ),
 518           array(
 519             'name' => ts('Status'),
 520             'sort' => 'contribution_status',
 521             'direction' => CRM_Utils_Sort::DONTCARE,
 522           ),
 523           array(
 524             'name' => ts('Premium'),
 525             'sort' => 'product_name',
 526             'direction' => CRM_Utils_Sort::DONTCARE,
 527           ),
 528         )
 529       );
 530     if (!$this->_single) {
 531       $pre = array(
 532         array('desc' => ts('Contact Type')),
 533         array(
 534           'name' => ts('Name'),
 535           'sort' => 'sort_name',
 536           'direction' => CRM_Utils_Sort::DONTCARE,
 537         ),
 538       );
 539       self::$_columnHeaders = array_merge($pre, self::$_columnHeaders);
 540     }
 541     if ($this->_includeSoftCredits) {
 542       self::$_columnHeaders = array_merge(
 543         self::$_columnHeaders,
 544         array(
 545           array(
 546             'name' => ts('Soft Credit For'),
 547             'sort' => 'contribution_soft_credit_name',
 548             'direction' => CRM_Utils_Sort::DONTCARE,
 549           ),
 550           array(
 551             'name' => ts('Soft Credit Type'),
 552             'sort' => 'contribution_soft_credit_type',
 553             'direction' => CRM_Utils_Sort::ASCENDING,
 554           ),
 555         )
 556       );
 557     }
 558     self::$_columnHeaders
 559       = array_merge(
 560         self::$_columnHeaders, array(
 561           array('desc' => ts('Actions')),
 562         )
 563       );
 564     return self::$_columnHeaders;
 565   }
 566
 567   /**
 568    * @return mixed
 569    */
 570   public function alphabetQuery() {
 571     return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
 572   }
 573
 574   /**
 575    * @return string
 576    */
 577   public function &getQuery() {
 578     return $this->_query;
 579   }
 580
 581   /**
 582    * Name of export file.
 583    *
 584    * @param string $output
 585    *   Type of output.
 586    *
 587    * @return string
 588    *   name of the file
 589    */
 590   public function getExportFileName($output = 'csv') {
 591     return ts('CiviCRM Contribution Search');
 592   }
 593
 594   /**
 595    * @return mixed
 596    */
 597   public function getSummary() {
 598     return $this->_query->summaryContribution($this->_context);
 599   }
 600
 601 }