CRM/Contact/Form/Search/Custom/FullText/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
  36
  37   function __construct() {
  38     parent::__construct('Contribution', ts('Contributions'));
  39   }
  40
  41   function isActive() {
  42     $config = CRM_Core_Config::singleton();
  43     return in_array('CiviContribute', $config->enableComponents) &&
  44       CRM_Core_Permission::check('access CiviContribute');
  45   }
  46
  47   /**
  48    * {@inheritdoc}
  49    */
  50   public function fillTempTable($queryText, $entityIDTableName, $toTable, $queryLimit, $detailLimit) {
  51     $queries = $this->prepareQueries($queryText, $entityIDTableName);
  52     $result = $this->runQueries($queryText, $queries, $entityIDTableName, $queryLimit);
  53     $this->moveIDs($entityIDTableName, $toTable, $detailLimit);
  54     return $result;
  55   }
  56
  57   /**
  58    * get contribution ids in entity tables.
  59    *
  60    * @param string $queryText
  61    * @param string $entityIDTableName
  62    * @return array list tables/queries (for runQueries)
  63    */
  64   function prepareQueries($queryText, $entityIDTableName) {
  65     // Note: For available full-text indices, see CRM_Core_InnoDBIndexer
  66
  67     $contactSQL = array();
  68     $contactSQL[] = "
  69 SELECT     distinct cc.id
  70 FROM       civicrm_contribution cc
  71 INNER JOIN civicrm_contact c ON cc.contact_id = c.id
  72 WHERE      ({$this->matchText('civicrm_contact c', array('sort_name', 'display_name', 'nick_name'), $queryText)})
  73 ";
  74     $tables = array(
  75       'civicrm_contribution' => array(
  76         'id' => 'id',
  77         'fields' => array(
  78           'source' => NULL,
  79           'amount_level' => NULL,
  80           'trxn_Id' => NULL,
  81           'invoice_id' => NULL,
  82           'check_number' => 'Int', // Odd: This is really a VARCHAR, so why are we searching like an INT?
  83           'total_amount' => 'Int',
  84         ),
  85       ),
  86       'sql' => $contactSQL,
  87       'civicrm_note' => array(
  88         'id' => 'entity_id',
  89         'entity_table' => 'civicrm_contribution',
  90         'fields' => array(
  91           'subject' => NULL,
  92           'note' => NULL,
  93         ),
  94       ),
  95     );
  96
  97     // get the custom data info
  98     $this->fillCustomInfo($tables, "( 'Contribution' )");
  99     return $tables;
 100   }
 101
 102   public function moveIDs($fromTable, $toTable, $limit) {
 103     $sql = "
 104 INSERT INTO {$toTable}
 105 ( table_name, contact_id, sort_name, contribution_id, financial_type, contribution_page, contribution_receive_date,
 106   contribution_total_amount, contribution_trxn_Id, contribution_source, contribution_status, contribution_check_number )
 107    SELECT  'Contribution', c.id, c.sort_name, cc.id, cct.name, ccp.title, cc.receive_date,
 108            cc.total_amount, cc.trxn_id, cc.source, contribution_status.label, cc.check_number
 109      FROM  {$fromTable} ct
 110 INNER JOIN civicrm_contribution cc ON cc.id = ct.entity_id
 111 LEFT JOIN  civicrm_contact c ON cc.contact_id = c.id
 112 LEFT JOIN  civicrm_financial_type cct ON cct.id = cc.financial_type_id
 113 LEFT JOIN  civicrm_contribution_page ccp ON ccp.id = cc.contribution_page_id
 114 LEFT JOIN  civicrm_option_group option_group_contributionStatus ON option_group_contributionStatus.name = 'contribution_status'
 115 LEFT JOIN  civicrm_option_value contribution_status ON
 116 ( contribution_status.option_group_id = option_group_contributionStatus.id AND contribution_status.value = cc.contribution_status_id )
 117 {$this->toLimit($limit)}
 118 ";
 119     CRM_Core_DAO::executeQuery($sql);
 120   }
 121
 122 }