1171 lines
50 KiB
PHP
1171 lines
50 KiB
PHP
<?php
|
|
/*
|
|
+--------------------------------------------------------------------+
|
|
| CiviCRM version 4.7 |
|
|
+--------------------------------------------------------------------+
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
|
+--------------------------------------------------------------------+
|
|
| This file is a part of CiviCRM. |
|
|
| |
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
|
| under the terms of the GNU Affero General Public License |
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
|
| |
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
|
| See the GNU Affero General Public License for more details. |
|
|
| |
|
|
| You should have received a copy of the GNU Affero General Public |
|
|
| License and the CiviCRM Licensing Exception along |
|
|
| with this program; if not, contact CiviCRM LLC |
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
|
+--------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
*
|
|
* @package CRM
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
|
*/
|
|
class CRM_Contribute_BAO_Query extends CRM_Core_BAO_Query {
|
|
|
|
static $_contribOrSoftCredit = "only_contribs";
|
|
|
|
static $_contribRecurPayment = NULL;
|
|
|
|
/**
|
|
* Function get the searchable fields for contribution.
|
|
*
|
|
* This is basically the contribution fields plus some related entity fields.
|
|
*
|
|
* @param bool $checkPermission
|
|
*
|
|
* @return array
|
|
* Associative array of contribution fields
|
|
*/
|
|
public static function getFields($checkPermission = TRUE) {
|
|
if (!isset(\Civi::$statics[__CLASS__]) || !isset(\Civi::$statics[__CLASS__]['fields']) || !isset(\Civi::$statics[__CLASS__]['contribution'])) {
|
|
$fields = CRM_Contribute_BAO_Contribution::exportableFields($checkPermission);
|
|
unset($fields['contribution_contact_id']);
|
|
\Civi::$statics[__CLASS__]['fields']['contribution'] = $fields;
|
|
}
|
|
return \Civi::$statics[__CLASS__]['fields']['contribution'];
|
|
}
|
|
|
|
/**
|
|
* If contributions are involved, add the specific contribute fields.
|
|
*
|
|
* @param CRM_Contact_BAO_Query $query
|
|
*/
|
|
public static function select(&$query) {
|
|
// if contribute mode add contribution id
|
|
if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
|
|
$query->_select['contribution_id'] = "civicrm_contribution.id as contribution_id";
|
|
$query->_element['contribution_id'] = 1;
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
}
|
|
|
|
// get financial_type
|
|
if (!empty($query->_returnProperties['financial_type'])) {
|
|
$query->_select['financial_type'] = "civicrm_financial_type.name as financial_type";
|
|
$query->_element['financial_type'] = 1;
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_financial_type'] = 1;
|
|
}
|
|
|
|
// get accounting code
|
|
if (!empty($query->_returnProperties['accounting_code'])) {
|
|
$query->_select['accounting_code'] = "civicrm_financial_account.accounting_code as accounting_code";
|
|
$query->_element['accounting_code'] = 1;
|
|
$query->_tables['civicrm_accounting_code'] = 1;
|
|
$query->_tables['civicrm_financial_account'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_note'])) {
|
|
$query->_select['contribution_note'] = "civicrm_note.note as contribution_note";
|
|
$query->_element['contribution_note'] = 1;
|
|
$query->_tables['contribution_note'] = 1;
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_batch'])) {
|
|
$query->_select['contribution_batch'] = "civicrm_batch.title as contribution_batch";
|
|
$query->_element['contribution_batch'] = 1;
|
|
$query->_tables['civicrm_financial_trxn'] = 1;
|
|
$query->_tables['contribution_batch'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_campaign_title'])) {
|
|
$query->_select['contribution_campaign_title'] = "civicrm_campaign.title as contribution_campaign_title";
|
|
$query->_element['contribution_campaign_title'] = $query->_tables['civicrm_campaign'] = 1;
|
|
}
|
|
|
|
self::addSoftCreditFields($query);
|
|
}
|
|
|
|
/**
|
|
* Get where clause.
|
|
*
|
|
* @param CRM_Contact_BAO_Query $query
|
|
*/
|
|
public static function where(&$query) {
|
|
self::initializeAnySoftCreditClause($query);
|
|
foreach (array_keys($query->_params) as $id) {
|
|
if (empty($query->_params[$id][0])) {
|
|
continue;
|
|
}
|
|
if (substr($query->_params[$id][0], 0, 13) == 'contribution_' || substr($query->_params[$id][0], 0, 10) == 'financial_' || substr($query->_params[$id][0], 0, 8) == 'payment_') {
|
|
if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) {
|
|
$query->_useDistinct = TRUE;
|
|
}
|
|
// CRM-12065
|
|
if (
|
|
$query->_params[$id][0] == 'contribution_type_id' ||
|
|
$query->_params[$id][0] == 'contribution_type'
|
|
) {
|
|
CRM_Core_Session::setStatus(
|
|
ts('The contribution type criteria is now obsolete, please update your smart group'),
|
|
'',
|
|
'alert'
|
|
);
|
|
continue;
|
|
}
|
|
|
|
self::whereClauseSingle($query->_params[$id], $query);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get where clause for a single value.
|
|
*
|
|
* @param array $values
|
|
* @param CRM_Contact_BAO_Query $query
|
|
*/
|
|
public static function whereClauseSingle(&$values, &$query) {
|
|
list($name, $op, $value, $grouping, $wildcard) = $values;
|
|
|
|
$quoteValue = NULL;
|
|
$fields = self::getFields();
|
|
|
|
if (!empty($value) && !is_array($value)) {
|
|
$quoteValue = "\"$value\"";
|
|
}
|
|
|
|
$strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
|
|
|
|
$recurrringFields = CRM_Contribute_BAO_ContributionRecur::getRecurringFields();
|
|
unset($recurrringFields['contribution_recur_payment_made']);
|
|
foreach ($recurrringFields as $dateField => $dateFieldTitle) {
|
|
if (self::buildDateWhere($values, $query, $name, $dateField, $dateFieldTitle)) {
|
|
return;
|
|
}
|
|
}
|
|
// These are legacy names.
|
|
// @todo enotices when these are hit so we can start to elimnate them.
|
|
$fieldAliases = array(
|
|
'financial_type' => 'financial_type_id',
|
|
'contribution_page' => 'contribution_page_id',
|
|
'payment_instrument' => 'payment_instrument_id',
|
|
// or payment_instrument_id?
|
|
'contribution_payment_instrument' => 'contribution_payment_instrument_id',
|
|
'contribution_status' => 'contribution_status_id',
|
|
);
|
|
$name = isset($fieldAliases[$name]) ? $fieldAliases[$name] : $name;
|
|
$qillName = $name;
|
|
$pseudoExtraParam = array();
|
|
|
|
switch ($name) {
|
|
case 'contribution_date':
|
|
case 'contribution_date_low':
|
|
case 'contribution_date_low_time':
|
|
case 'contribution_date_high':
|
|
case 'contribution_date_high_time':
|
|
// process to / from date
|
|
$query->dateQueryBuilder($values,
|
|
'civicrm_contribution', 'contribution_date', 'receive_date', 'Contribution Date'
|
|
);
|
|
return;
|
|
|
|
case 'contribution_amount':
|
|
case 'contribution_amount_low':
|
|
case 'contribution_amount_high':
|
|
// process min/max amount
|
|
$query->numberRangeBuilder($values,
|
|
'civicrm_contribution', 'contribution_amount',
|
|
'total_amount', 'Contribution Amount',
|
|
NULL
|
|
);
|
|
return;
|
|
|
|
case 'contribution_thankyou_date_is_not_null':
|
|
if ($value) {
|
|
$op = "IS NOT NULL";
|
|
$query->_qill[$grouping][] = ts('Contribution Thank-you Sent');
|
|
}
|
|
else {
|
|
$op = "IS NULL";
|
|
$query->_qill[$grouping][] = ts('Contribution Thank-you Not Sent');
|
|
}
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.thankyou_date", $op);
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
return;
|
|
|
|
case 'contribution_receipt_date_is_not_null':
|
|
if ($value) {
|
|
$op = "IS NOT NULL";
|
|
$query->_qill[$grouping][] = ts('Contribution Receipt Sent');
|
|
}
|
|
else {
|
|
$op = "IS NULL";
|
|
$query->_qill[$grouping][] = ts('Contribution Receipt Not Sent');
|
|
}
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.receipt_date", $op);
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
return;
|
|
|
|
case 'financial_type_id':
|
|
// @todo we need to make this resemble a hook approach.
|
|
CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.$name", 'IN', array_keys($financialTypes), 'String');
|
|
case 'invoice_id':
|
|
case 'invoice_number':
|
|
case 'payment_instrument_id':
|
|
case 'contribution_payment_instrument_id':
|
|
case 'contribution_page_id':
|
|
case 'contribution_status_id':
|
|
case 'contribution_id':
|
|
case 'contribution_currency_type':
|
|
case 'contribution_currency':
|
|
case 'contribution_source':
|
|
case 'contribution_trxn_id':
|
|
case 'contribution_check_number':
|
|
case 'contribution_contact_id':
|
|
case (strpos($name, '_amount') !== FALSE):
|
|
case (strpos($name, '_date') !== FALSE && $name != 'contribution_fulfilled_date'):
|
|
case 'contribution_campaign_id':
|
|
|
|
$fieldNamesNotToStripContributionFrom = array(
|
|
'contribution_currency_type',
|
|
'contribution_status_id',
|
|
'contribution_page_id',
|
|
);
|
|
// @todo these are mostly legacy params. Find a better way to deal with them.
|
|
if (!in_array($name, $fieldNamesNotToStripContributionFrom)
|
|
) {
|
|
if (!isset($fields[$name])) {
|
|
$qillName = str_replace('contribution_', '', $qillName);
|
|
}
|
|
$name = str_replace('contribution_', '', $name);
|
|
}
|
|
if (in_array($name, array('contribution_currency', 'contribution_currency_type'))) {
|
|
$qillName = $name = 'currency';
|
|
$pseudoExtraParam = array('labelColumn' => 'name');
|
|
}
|
|
|
|
$dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
|
|
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.$name", $op, $value, $dataType);
|
|
list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Contribution', $name, $value, $op, $pseudoExtraParam);
|
|
$query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
return;
|
|
|
|
case 'contribution_pcp_made_through_id':
|
|
case 'contribution_soft_credit_type_id':
|
|
$qillName = $name;
|
|
if ($name == 'contribution_pcp_made_through_id') {
|
|
$qillName = $name = 'pcp_id';
|
|
$fields[$name] = array('title' => ts('Personal Campaign Page'), 'type' => 2);
|
|
}
|
|
if ($name == 'contribution_soft_credit_type_id') {
|
|
$qillName = str_replace('_id', '', $qillName);
|
|
$fields[$qillName]['type'] = $fields[$qillName]['data_type'];
|
|
$name = str_replace('contribution_', '', $name);
|
|
}
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_soft.$name",
|
|
$op, $value, CRM_Utils_Type::typeToString($fields[$qillName]['type'])
|
|
);
|
|
list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionSoft', $name, $value, $op);
|
|
$query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
|
|
$query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
|
|
return;
|
|
|
|
case 'contribution_or_softcredits':
|
|
if ($value == 'only_scredits') {
|
|
$query->_where[$grouping][] = "contribution_search_scredit_combined.scredit_id IS NOT NULL";
|
|
$query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits Only');
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
|
|
}
|
|
elseif ($value == 'both_related') {
|
|
$query->_where[$grouping][] = "contribution_search_scredit_combined.filter_id IS NOT NULL";
|
|
$query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Soft Credits with related Hard Credit');
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
|
|
}
|
|
elseif ($value == 'both') {
|
|
$query->_qill[$grouping][] = ts('Contributions OR Soft Credits? - Both');
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
|
|
}
|
|
// default option: $value == 'only_contribs'
|
|
return;
|
|
|
|
case 'contribution_is_test':
|
|
// By default is Contribution Search form we choose is_test = 0 in otherwords always show active contribution
|
|
// so in case if any one choose any Yes/No avoid the default clause otherwise it will be conflict in whereClause
|
|
$key = array_search('civicrm_contribution.is_test = 0', $query->_where[$grouping]);
|
|
if (!empty($key)) {
|
|
unset($query->_where[$grouping][$key]);
|
|
}
|
|
case 'contribution_test':
|
|
// We dont want to include all tests for sql OR CRM-7827
|
|
if (!$value || $query->getOperator() != 'OR') {
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_test", $op, $value, "Boolean");
|
|
if ($value) {
|
|
$query->_qill[$grouping][] = ts("Only Display Test Contributions");
|
|
}
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
}
|
|
return;
|
|
|
|
case 'contribution_is_pay_later':
|
|
case 'contribution_pay_later':
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.is_pay_later", $op, $value, "Boolean");
|
|
if ($value) {
|
|
$query->_qill[$grouping][] = ts("Find Pay Later Contributions");
|
|
}
|
|
else {
|
|
$query->_qill[$grouping][] = ts("Exclude Pay Later Contributions");
|
|
}
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
return;
|
|
|
|
case 'contribution_recurring':
|
|
if ($value) {
|
|
$query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NOT NULL";
|
|
$query->_qill[$grouping][] = ts("Find Recurring Contributions");
|
|
$query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
|
|
}
|
|
else {
|
|
$query->_where[$grouping][] = "civicrm_contribution.contribution_recur_id IS NULL";
|
|
$query->_qill[$grouping][] = ts("Exclude Recurring Contributions");
|
|
}
|
|
return;
|
|
|
|
case 'contribution_recur_id':
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.contribution_recur_id",
|
|
$op, $value, "Integer"
|
|
);
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
return;
|
|
|
|
case 'contribution_recur_processor_id':
|
|
case 'contribution_recur_trxn_id':
|
|
$fieldName = str_replace('contribution_recur_', '', $name);
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.{$fieldName}",
|
|
$op, $value, "String"
|
|
);
|
|
$query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
|
|
return;
|
|
|
|
case 'contribution_recur_payment_made':
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.id", 'IS NOT EMPTY');
|
|
if ($value == 2) {
|
|
$query->_qill[$grouping][] = ts("Recurring contributions with at least one payment");
|
|
self::$_contribRecurPayment = TRUE;
|
|
}
|
|
else {
|
|
$query->_qill[$grouping][] = ts("All recurring contributions regardless of payments");
|
|
self::$_contribRecurPayment = FALSE;
|
|
}
|
|
$query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
|
|
return;
|
|
|
|
case 'contribution_recur_contribution_status_id':
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution_recur.contribution_status_id", $op, $value, 'String');
|
|
list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_ContributionRecur', 'contribution_status_id', $value, $op, $pseudoExtraParam);
|
|
$query->_qill[$grouping][] = ts("Recurring Contribution Status %1 '%2'", array(1 => $op, 2 => $value));
|
|
$query->_tables['civicrm_contribution_recur'] = $query->_whereTables['civicrm_contribution_recur'] = 1;
|
|
return;
|
|
|
|
case 'contribution_note':
|
|
$value = $strtolower(CRM_Core_DAO::escapeString($value));
|
|
if ($wildcard) {
|
|
$value = "%$value%";
|
|
$op = 'LIKE';
|
|
}
|
|
// LOWER roughly translates to 'hurt my database without deriving any benefit' See CRM-19811.
|
|
$wc = ($op != 'LIKE') ? "LOWER(civicrm_note.note)" : "civicrm_note.note";
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($wc, $op, $value, "String");
|
|
$query->_qill[$grouping][] = ts('Contribution Note %1 %2', array(1 => $op, 2 => $quoteValue));
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = $query->_whereTables['contribution_note'] = 1;
|
|
return;
|
|
|
|
case 'contribution_membership_id':
|
|
$query->_where[$grouping][] = " civicrm_membership.id $op $value";
|
|
$query->_tables['contribution_membership'] = $query->_whereTables['contribution_membership'] = 1;
|
|
|
|
return;
|
|
|
|
case 'contribution_participant_id':
|
|
$query->_where[$grouping][] = " civicrm_participant.id $op $value";
|
|
$query->_tables['contribution_participant'] = $query->_whereTables['contribution_participant'] = 1;
|
|
return;
|
|
|
|
case 'contribution_pcp_display_in_roll':
|
|
$query->_where[$grouping][] = " civicrm_contribution_soft.pcp_display_in_roll $op '$value'";
|
|
if ($value) {
|
|
$query->_qill[$grouping][] = ts("Personal Campaign Page Honor Roll");
|
|
}
|
|
else {
|
|
$query->_qill[$grouping][] = ts("NOT Personal Campaign Page Honor Roll");
|
|
}
|
|
$query->_tables['civicrm_contribution_soft'] = $query->_whereTables['civicrm_contribution_soft'] = 1;
|
|
return;
|
|
|
|
case 'contribution_batch_id':
|
|
list($qillOp, $qillValue) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Batch_BAO_EntityBatch', 'batch_id', $value, $op);
|
|
$query->_qill[$grouping][] = ts('Batch Name %1 %2', array(1 => $qillOp, 2 => $qillValue));
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_entity_batch.batch_id', $op, $value);
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1;
|
|
$query->_tables['contribution_batch'] = $query->_whereTables['contribution_batch'] = 1;
|
|
return;
|
|
|
|
case 'contribution_product_id':
|
|
// CRM-16713 - contribution search by premiums on 'Find Contribution' form.
|
|
$qillName = $name;
|
|
list($operator, $productValue) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Contribute_DAO_Product', $name, $value, $op);
|
|
$query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $operator, 3 => $productValue));
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_product.id", $op, $value);
|
|
$query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1;
|
|
return;
|
|
|
|
case 'contribution_is_payment':
|
|
$query->_where[$grouping][] = " civicrm_financial_trxn.is_payment $op $value";
|
|
$query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1;
|
|
return;
|
|
|
|
case 'financial_trxn_card_type_id':
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_financial_trxn.card_type_id', $op, $value);
|
|
$query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1;
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Financial_DAO_FinancialTrxn', 'card_type_id', $value, $op);
|
|
$query->_qill[$grouping][] = ts('Card Type %1 %2', array(1 => $op, 2 => $value));
|
|
return;
|
|
|
|
case 'financial_trxn_pan_truncation':
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('civicrm_financial_trxn.pan_truncation', $op, $value);
|
|
$query->_tables['civicrm_financial_trxn'] = $query->_whereTables['civicrm_financial_trxn'] = 1;
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Financial_DAO_FinancialTrxn', 'pan_truncation', $value, $op);
|
|
$query->_qill[$grouping][] = ts('Card Number %1 %2', array(1 => $op, 2 => $value));
|
|
return;
|
|
|
|
default:
|
|
//all other elements are handle in this case
|
|
$fldName = substr($name, 13);
|
|
CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_contribution.financial_type_id", 'IN', array_keys($financialTypes), 'String');
|
|
if (!isset($fields[$fldName])) {
|
|
// CRM-12597
|
|
CRM_Core_Session::setStatus(ts(
|
|
'We did not recognize the search field: %1. Please check and fix your contribution related smart groups.',
|
|
array(1 => $fldName)
|
|
)
|
|
);
|
|
return;
|
|
}
|
|
$whereTable = $fields[$fldName];
|
|
$value = trim($value);
|
|
|
|
$dataType = "String";
|
|
if (!empty($whereTable['type'])) {
|
|
$dataType = CRM_Utils_Type::typeToString($whereTable['type']);
|
|
}
|
|
|
|
$query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause($whereTable['where'], $op, $value, $dataType);
|
|
$query->_qill[$grouping][] = "$whereTable[title] $op $quoteValue";
|
|
list($tableName) = explode('.', $whereTable['where'], 2);
|
|
$query->_tables[$tableName] = $query->_whereTables[$tableName] = 1;
|
|
if ($tableName == 'civicrm_contribution_product') {
|
|
$query->_tables['civicrm_product'] = $query->_whereTables['civicrm_product'] = 1;
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
}
|
|
else {
|
|
$query->_tables['civicrm_contribution'] = $query->_whereTables['civicrm_contribution'] = 1;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get from clause.
|
|
*
|
|
* @param string $name
|
|
* @param string $mode
|
|
* @param string $side
|
|
*
|
|
* @return NULL|string
|
|
*/
|
|
public static function from($name, $mode, $side) {
|
|
$from = NULL;
|
|
switch ($name) {
|
|
case 'civicrm_contribution':
|
|
$from = " $side JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id ";
|
|
if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
|
|
// switch the from table if its only soft credit search
|
|
$from = " $side JOIN contribution_search_scredit_combined ON contribution_search_scredit_combined.contact_id = contact_a.id ";
|
|
$from .= " $side JOIN civicrm_contribution ON civicrm_contribution.id = contribution_search_scredit_combined.id ";
|
|
$from .= " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.id = contribution_search_scredit_combined.scredit_id";
|
|
}
|
|
break;
|
|
|
|
case 'civicrm_contribution_recur':
|
|
if ($mode == 1) {
|
|
// 'Made payment for the recurring contributions?' is ticked yes
|
|
$from = " $side JOIN civicrm_contribution_recur ON contact_a.id = civicrm_contribution_recur.contact_id ";
|
|
if (self::$_contribRecurPayment == TRUE) {
|
|
$from .= " INNER JOIN civicrm_contribution cr ON cr.contribution_recur_id = civicrm_contribution_recur.id ";
|
|
}
|
|
}
|
|
else {
|
|
$from = " $side JOIN civicrm_contribution_recur ON civicrm_contribution.contribution_recur_id = civicrm_contribution_recur.id ";
|
|
}
|
|
break;
|
|
|
|
case 'civicrm_financial_type':
|
|
if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
|
|
$from = " INNER JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
|
|
}
|
|
else {
|
|
$from = " $side JOIN civicrm_financial_type ON civicrm_contribution.financial_type_id = civicrm_financial_type.id ";
|
|
}
|
|
break;
|
|
|
|
case 'civicrm_financial_account':
|
|
if ($mode & CRM_Contact_BAO_Query::MODE_CONTACTS) {
|
|
$from = " $side JOIN civicrm_financial_account ON contact_a.id = civicrm_financial_account.contact_id ";
|
|
}
|
|
break;
|
|
|
|
case 'civicrm_accounting_code':
|
|
if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
|
|
$from = " $side JOIN civicrm_entity_financial_account ON civicrm_entity_financial_account.entity_id = civicrm_contribution.financial_type_id AND civicrm_entity_financial_account.entity_table = 'civicrm_financial_type' ";
|
|
$from .= " INNER JOIN civicrm_financial_account ON civicrm_financial_account.id = civicrm_entity_financial_account.financial_account_id ";
|
|
$from .= " INNER JOIN civicrm_option_value cov ON cov.value = civicrm_entity_financial_account.account_relationship AND cov.name = 'Income Account is' ";
|
|
$from .= " INNER JOIN civicrm_option_group cog ON cog.id = cov.option_group_id AND cog.name = 'account_relationship' ";
|
|
}
|
|
break;
|
|
|
|
case 'civicrm_contribution_page':
|
|
$from = " $side JOIN civicrm_contribution_page ON civicrm_contribution.contribution_page_id = civicrm_contribution_page.id";
|
|
break;
|
|
|
|
case 'civicrm_product':
|
|
$from = " $side JOIN civicrm_contribution_product ON civicrm_contribution_product.contribution_id = civicrm_contribution.id";
|
|
$from .= " $side JOIN civicrm_product ON civicrm_contribution_product.product_id =civicrm_product.id ";
|
|
break;
|
|
|
|
case 'contribution_softcredit_type':
|
|
$from = " $side JOIN civicrm_option_group option_group_contribution_softcredit_type ON
|
|
(option_group_contribution_softcredit_type.name = 'soft_credit_type')";
|
|
$from .= " $side JOIN civicrm_option_value contribution_softcredit_type ON
|
|
( civicrm_contribution_soft.soft_credit_type_id = contribution_softcredit_type.value
|
|
AND option_group_contribution_softcredit_type.id = contribution_softcredit_type.option_group_id )";
|
|
break;
|
|
|
|
case 'contribution_note':
|
|
$from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contribution' AND
|
|
civicrm_contribution.id = civicrm_note.entity_id )";
|
|
break;
|
|
|
|
case 'contribution_membership':
|
|
$from = " $side JOIN civicrm_membership_payment ON civicrm_membership_payment.contribution_id = civicrm_contribution.id";
|
|
$from .= " $side JOIN civicrm_membership ON civicrm_membership_payment.membership_id = civicrm_membership.id ";
|
|
break;
|
|
|
|
case 'civicrm_campaign':
|
|
//CRM-16764 - get survey clause from campaign bao
|
|
if (!CRM_Campaign_BAO_Query::$_applySurveyClause) {
|
|
$from = " $side JOIN civicrm_campaign ON civicrm_campaign.id = civicrm_contribution.campaign_id";
|
|
}
|
|
break;
|
|
|
|
case 'contribution_participant':
|
|
$from = " $side JOIN civicrm_participant_payment ON civicrm_participant_payment.contribution_id = civicrm_contribution.id";
|
|
$from .= " $side JOIN civicrm_participant ON civicrm_participant_payment.participant_id = civicrm_participant.id ";
|
|
break;
|
|
|
|
case 'civicrm_contribution_soft':
|
|
if (!in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
|
|
$from = " $side JOIN civicrm_contribution_soft ON civicrm_contribution_soft.contribution_id = civicrm_contribution.id";
|
|
}
|
|
break;
|
|
|
|
case 'civicrm_contribution_soft_contact':
|
|
if (in_array(self::$_contribOrSoftCredit, array("only_scredits", "both_related", "both"))) {
|
|
$from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution.contact_id = civicrm_contact_d.id )
|
|
AND contribution_search_scredit_combined.scredit_id IS NOT NULL";
|
|
}
|
|
else {
|
|
$from .= " $side JOIN civicrm_contact civicrm_contact_d ON (civicrm_contribution_soft.contact_id = civicrm_contact_d.id )";
|
|
}
|
|
break;
|
|
|
|
case 'civicrm_contribution_soft_email':
|
|
$from .= " $side JOIN civicrm_email as soft_email ON (civicrm_contact_d.id = soft_email.contact_id )";
|
|
break;
|
|
|
|
case 'civicrm_contribution_soft_phone':
|
|
$from .= " $side JOIN civicrm_phone as soft_phone ON (civicrm_contact_d.id = soft_phone.contact_id )";
|
|
break;
|
|
|
|
case 'contribution_batch':
|
|
$from .= " $side JOIN civicrm_entity_batch ON ( civicrm_entity_batch.entity_table = 'civicrm_financial_trxn'
|
|
AND civicrm_financial_trxn.id = civicrm_entity_batch.entity_id )";
|
|
|
|
$from .= " $side JOIN civicrm_batch ON civicrm_entity_batch.batch_id = civicrm_batch.id";
|
|
break;
|
|
|
|
case 'civicrm_financial_trxn':
|
|
$from .= " $side JOIN civicrm_entity_financial_trxn ON (
|
|
civicrm_entity_financial_trxn.entity_table = 'civicrm_contribution'
|
|
AND civicrm_contribution.id = civicrm_entity_financial_trxn.entity_id )";
|
|
|
|
$from .= " $side JOIN civicrm_financial_trxn ON (
|
|
civicrm_entity_financial_trxn.financial_trxn_id = civicrm_financial_trxn.id )";
|
|
break;
|
|
}
|
|
return $from;
|
|
}
|
|
|
|
/**
|
|
* Initialise the soft credit clause.
|
|
*
|
|
* @param CRM_Contact_BAO_Query $query
|
|
*/
|
|
public static function initializeAnySoftCreditClause(&$query) {
|
|
// @todo have a generic initialize on all components that gets called every query
|
|
// & rename this to match that fn name.
|
|
if ($query->_mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
|
|
if (self::isSoftCreditOptionEnabled($query->_params)) {
|
|
unset($query->_distinctComponentClause);
|
|
$query->_rowCountClause = " count(civicrm_contribution.id)";
|
|
$query->_groupByComponentClause = " GROUP BY contribution_search_scredit_combined.id, contribution_search_scredit_combined.contact_id, contribution_search_scredit_combined.scredit_id ";
|
|
}
|
|
else {
|
|
$query->_distinctComponentClause = ' civicrm_contribution.id';
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if soft credits are enables.
|
|
*
|
|
* @param array $queryParams
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function isSoftCreditOptionEnabled($queryParams = array()) {
|
|
static $tempTableFilled = FALSE;
|
|
if (!empty($queryParams)) {
|
|
foreach (array_keys($queryParams) as $id) {
|
|
if (empty($queryParams[$id][0])) {
|
|
continue;
|
|
}
|
|
if ($queryParams[$id][0] == 'contribution_or_softcredits') {
|
|
self::$_contribOrSoftCredit = $queryParams[$id][2];
|
|
}
|
|
}
|
|
}
|
|
if (in_array(self::$_contribOrSoftCredit,
|
|
array("only_scredits", "both_related", "both"))) {
|
|
if (!$tempTableFilled) {
|
|
// build a temp table which is union of contributions and soft credits
|
|
// note: group-by in first part ensures uniqueness in counts
|
|
$tempQuery = "
|
|
CREATE TEMPORARY TABLE IF NOT EXISTS contribution_search_scredit_combined AS
|
|
SELECT con.id as id, con.contact_id, cso.id as filter_id, NULL as scredit_id
|
|
FROM civicrm_contribution con
|
|
LEFT JOIN civicrm_contribution_soft cso ON con.id = cso.contribution_id
|
|
GROUP BY id, contact_id, scredit_id, cso.id
|
|
UNION ALL
|
|
SELECT scredit.contribution_id as id, scredit.contact_id, scredit.id as filter_id, scredit.id as scredit_id
|
|
FROM civicrm_contribution_soft as scredit";
|
|
CRM_Core_DAO::executeQuery($tempQuery);
|
|
$tempTableFilled = TRUE;
|
|
}
|
|
return TRUE;
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* Get return properties for soft credits.
|
|
*
|
|
* @param bool $isExportMode
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function softCreditReturnProperties($isExportMode = FALSE) {
|
|
$properties = array(
|
|
'contribution_soft_credit_name' => 1,
|
|
'contribution_soft_credit_amount' => 1,
|
|
'contribution_soft_credit_type' => 1,
|
|
);
|
|
if ($isExportMode) {
|
|
$properties['contribution_soft_credit_contact_id'] = 1;
|
|
$properties['contribution_soft_credit_contribution_id'] = 1;
|
|
}
|
|
return $properties;
|
|
}
|
|
|
|
/**
|
|
* Get the list of fields required to populate the selector.
|
|
*
|
|
* The default return properties array returns far too many fields for 'everyday use. Every field you add to this array
|
|
* kills a small kitten so add carefully.
|
|
*/
|
|
public static function selectorReturnProperties() {
|
|
$properties = array(
|
|
'contact_type' => 1,
|
|
'contact_sub_type' => 1,
|
|
'sort_name' => 1,
|
|
'financial_type' => 1,
|
|
'contribution_source' => 1,
|
|
'is_test' => 1,
|
|
'receive_date' => 1,
|
|
'is_pay_later' => 1,
|
|
'thankyou_date' => 1,
|
|
'total_amount' => 1,
|
|
// Without this value here we get an e-notice BUT the value does not appear to be rendered anywhere.
|
|
'contribution_campaign_id' => 1,
|
|
'contribution_status_id' => 1,
|
|
// @todo return this & fix query to do pseudoconstant thing.
|
|
'contribution_status' => 1,
|
|
// @todo the product field got added because it suited someone's use case.
|
|
// ideally we would have some configurability here because I think 90% of sites would
|
|
// disagree this is the right field to show - but they wouldn't agree with each other
|
|
// on what field to show instead.
|
|
'contribution_product_id' => 1,
|
|
'product_name' => 1,
|
|
'currency' => 1,
|
|
'cancel_date' => 1,
|
|
'contribution_recur_id' => 1,
|
|
);
|
|
if (self::isSoftCreditOptionEnabled()) {
|
|
$properties = array_merge($properties, self::softCreditReturnProperties());
|
|
}
|
|
|
|
return $properties;
|
|
}
|
|
|
|
/**
|
|
* Function you should avoid.
|
|
*
|
|
* This function returns default properties for contribution queries. However, they are
|
|
* far more than are required in 'most' cases and you should always try to return the return properties
|
|
* you actually require.
|
|
*
|
|
* It would be nice to throw an e-notice when this is called but it would trash the tests :-(.
|
|
*
|
|
* @param int $mode
|
|
* @param bool $includeCustomFields
|
|
*
|
|
* @return array|NULL
|
|
*/
|
|
public static function defaultReturnProperties($mode, $includeCustomFields = TRUE) {
|
|
$properties = NULL;
|
|
if ($mode & CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
|
|
$properties = array(
|
|
// add
|
|
'contact_type' => 1,
|
|
// fields
|
|
'contact_sub_type' => 1,
|
|
// to
|
|
'sort_name' => 1,
|
|
//this
|
|
'display_name' => 1,
|
|
// array
|
|
'financial_type' => 1,
|
|
// to
|
|
'contribution_source' => 1,
|
|
// strangle
|
|
'receive_date' => 1,
|
|
// site
|
|
'thankyou_date' => 1,
|
|
// performance
|
|
'cancel_date' => 1,
|
|
// and
|
|
'total_amount' => 1,
|
|
// torture
|
|
'accounting_code' => 1,
|
|
// small
|
|
'payment_instrument' => 1,
|
|
// kittens
|
|
'payment_instrument_id' => 1,
|
|
// argh
|
|
'contribution_check_number' => 1,
|
|
// no
|
|
'non_deductible_amount' => 1,
|
|
// not
|
|
'fee_amount' => 1,
|
|
// another
|
|
'net_amount' => 1,
|
|
// expensive
|
|
'trxn_id' => 1,
|
|
// join
|
|
'invoice_id' => 1,
|
|
'invoice_number' => 1,
|
|
// added
|
|
'currency' => 1,
|
|
// to
|
|
'cancel_reason' => 1,
|
|
//every
|
|
'receipt_date' => 1,
|
|
// query
|
|
'product_name' => 1,
|
|
//whether
|
|
'sku' => 1,
|
|
// or
|
|
'product_option' => 1,
|
|
// not
|
|
'fulfilled_date' => 1,
|
|
// the
|
|
'contribution_start_date' => 1,
|
|
// field
|
|
'contribution_end_date' => 1,
|
|
// is
|
|
'is_test' => 1,
|
|
// actually
|
|
'is_pay_later' => 1,
|
|
// required
|
|
'contribution_status' => 1,
|
|
// instead
|
|
'contribution_status_id' => 1,
|
|
// of
|
|
'contribution_recur_id' => 1,
|
|
// adding
|
|
'amount_level' => 1,
|
|
// here
|
|
'contribution_note' => 1,
|
|
// set
|
|
'contribution_batch' => 1,
|
|
// return properties
|
|
'contribution_campaign_title' => 1,
|
|
// on
|
|
'contribution_campaign_id' => 1,
|
|
// calling
|
|
'contribution_product_id' => 1,
|
|
//function
|
|
);
|
|
if (self::isSoftCreditOptionEnabled()) {
|
|
$properties = array_merge($properties, self::softCreditReturnProperties());
|
|
}
|
|
if ($includeCustomFields) {
|
|
// also get all the custom contribution properties
|
|
$fields = CRM_Core_BAO_CustomField::getFieldsForImport('Contribution');
|
|
if (!empty($fields)) {
|
|
foreach ($fields as $name => $dontCare) {
|
|
$properties[$name] = 1;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $properties;
|
|
}
|
|
|
|
/**
|
|
* Add all the elements shared between contribute search and advnaced search.
|
|
*
|
|
* @param CRM_Core_Form $form
|
|
*/
|
|
public static function buildSearchForm(&$form) {
|
|
|
|
// Added contribution source
|
|
$form->addElement('text', 'contribution_source', ts('Contribution Source'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution', 'source'));
|
|
|
|
CRM_Core_Form_Date::buildDateRange($form, 'contribution_date', 1, '_low', '_high', ts('From:'), FALSE);
|
|
// CRM-17602
|
|
// This hidden element added for displaying Date Range error correctly. Definitely a dirty hack, but... it works.
|
|
$form->addElement('hidden', 'contribution_date_range_error');
|
|
$form->addFormRule(array('CRM_Contribute_BAO_Query', 'formRule'), $form);
|
|
|
|
$form->add('text', 'contribution_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
|
|
$form->addRule('contribution_amount_low', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('9.99', ' '))), 'money');
|
|
|
|
$form->add('text', 'contribution_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
|
|
$form->addRule('contribution_amount_high', ts('Please enter a valid money value (e.g. %1).', array(1 => CRM_Utils_Money::format('99.99', ' '))), 'money');
|
|
|
|
// Adding select option for curreny type -- CRM-4711
|
|
$form->add('select', 'contribution_currency_type',
|
|
ts('Currency Type'),
|
|
array(
|
|
'' => ts('- any -'),
|
|
) +
|
|
CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'currency', array('labelColumn' => 'name')),
|
|
FALSE, array('class' => 'crm-select2')
|
|
);
|
|
|
|
// CRM-13848
|
|
CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes, CRM_Core_Action::VIEW);
|
|
$form->addSelect('financial_type_id',
|
|
array('entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search', 'options' => $financialTypes)
|
|
);
|
|
|
|
$form->add('select', 'contribution_page_id',
|
|
ts('Contribution Page'),
|
|
CRM_Contribute_PseudoConstant::contributionPage(),
|
|
FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -'))
|
|
);
|
|
|
|
$form->addSelect('payment_instrument_id',
|
|
array('entity' => 'contribution', 'multiple' => 'multiple', 'label' => ts('Payment Method'), 'option_url' => NULL, 'placeholder' => ts('- any -'))
|
|
);
|
|
|
|
$form->add('select',
|
|
'contribution_pcp_made_through_id',
|
|
ts('Personal Campaign Page'),
|
|
CRM_Contribute_PseudoConstant::pcPage(), FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')));
|
|
|
|
$statusValues = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id');
|
|
// Remove status values that are only used for recurring contributions or pledges (In Progress, Overdue).
|
|
unset($statusValues['5'], $statusValues['6']);
|
|
$form->add('select', 'contribution_status_id',
|
|
ts('Contribution Status'), $statusValues,
|
|
FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple')
|
|
);
|
|
|
|
// Add fields for thank you and receipt
|
|
$form->addYesNo('contribution_thankyou_date_is_not_null', ts('Thank-you sent?'), TRUE);
|
|
$form->addYesNo('contribution_receipt_date_is_not_null', ts('Receipt sent?'), TRUE);
|
|
|
|
$form->addYesNo('contribution_pay_later', ts('Contribution is Pay Later?'), TRUE);
|
|
$form->addYesNo('contribution_recurring', ts('Contribution is Recurring?'), TRUE);
|
|
|
|
$form->addYesNo('contribution_test', ts('Contribution is a Test?'), TRUE);
|
|
|
|
// Add field for transaction ID search
|
|
$form->addElement('text', 'contribution_trxn_id', ts("Transaction ID"));
|
|
$form->addElement('text', 'invoice_number', ts("Invoice Number"));
|
|
$form->addElement('text', 'contribution_check_number', ts('Check Number'));
|
|
|
|
// Add field for pcp display in roll search
|
|
$form->addYesNo('contribution_pcp_display_in_roll', ts('Personal Campaign Page Honor Roll?'), TRUE);
|
|
|
|
// Soft credit related fields
|
|
$options = array(
|
|
'only_contribs' => ts('Contributions Only'),
|
|
'only_scredits' => ts('Soft Credits Only'),
|
|
'both_related' => ts('Soft Credits with related Hard Credit'),
|
|
'both' => ts('Both'),
|
|
);
|
|
$form->add('select', 'contribution_or_softcredits', ts('Contributions OR Soft Credits?'), $options, FALSE, array('class' => "crm-select2"));
|
|
$form->addSelect(
|
|
'contribution_soft_credit_type_id',
|
|
array(
|
|
'entity' => 'contribution_soft',
|
|
'field' => 'soft_credit_type_id',
|
|
'multiple' => TRUE,
|
|
'context' => 'search',
|
|
)
|
|
);
|
|
|
|
$form->addField('financial_trxn_card_type_id', array('entity' => 'FinancialTrxn', 'name' => 'card_type_id', 'action' => 'get'));
|
|
|
|
$form->add('text', 'financial_trxn_pan_truncation', ts('Card Number'), array(
|
|
'size' => 5,
|
|
'maxlength' => 4,
|
|
'autocomplete' => 'off',
|
|
));
|
|
|
|
// CRM-16713 - contribution search by premiums on 'Find Contribution' form.
|
|
$form->add('select', 'contribution_product_id',
|
|
ts('Premium'),
|
|
CRM_Contribute_PseudoConstant::products(),
|
|
FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -'))
|
|
);
|
|
|
|
self::addCustomFormFields($form, array('Contribution'));
|
|
|
|
CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'contribution_campaign_id');
|
|
|
|
// Add batch select
|
|
$batches = CRM_Contribute_PseudoConstant::batch();
|
|
|
|
if (!empty($batches)) {
|
|
$form->add('select', 'contribution_batch_id',
|
|
ts('Batch Name'),
|
|
array(
|
|
'' => ts('- any -'),
|
|
// CRM-19325
|
|
'IS NULL' => ts('None'),
|
|
) + $batches,
|
|
FALSE, array('class' => 'crm-select2')
|
|
);
|
|
}
|
|
|
|
$form->assign('validCiviContribute', TRUE);
|
|
$form->setDefaults(array('contribution_test' => 0));
|
|
|
|
CRM_Contribute_BAO_ContributionRecur::recurringContribution($form);
|
|
}
|
|
|
|
/**
|
|
* Get table names.
|
|
*
|
|
* @todo better function comment needed - what IS the point of this?
|
|
*
|
|
* @param array $tables
|
|
*/
|
|
public static function tableNames(&$tables) {
|
|
// Add contribution table
|
|
if (!empty($tables['civicrm_product'])) {
|
|
$tables = array_merge(array('civicrm_contribution' => 1), $tables);
|
|
}
|
|
|
|
if (!empty($tables['civicrm_contribution_product']) && empty($tables['civicrm_product'])) {
|
|
$tables['civicrm_product'] = 1;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add the where for dates.
|
|
*
|
|
* @param array $values
|
|
* Array of query values.
|
|
* @param object $query
|
|
* The query object.
|
|
* @param string $name
|
|
* Query field that is set.
|
|
* @param string $field
|
|
* Name of field to be set.
|
|
* @param string $title
|
|
* Title of the field.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function buildDateWhere(&$values, $query, $name, $field, $title) {
|
|
$fieldPart = strpos($name, $field);
|
|
if ($fieldPart === FALSE) {
|
|
return NULL;
|
|
}
|
|
// we only have recurring dates using this ATM so lets' short cut to find the table name
|
|
$table = 'contribution_recur';
|
|
$fieldName = explode($table . '_', $field);
|
|
$query->dateQueryBuilder($values,
|
|
'civicrm_' . $table, $field, $fieldName[1], $title
|
|
);
|
|
return TRUE;
|
|
}
|
|
|
|
/**
|
|
* Custom form rules.
|
|
*
|
|
* @param array $fields
|
|
* @param array $files
|
|
* @param CRM_Core_Form $form
|
|
*
|
|
* @return bool|array
|
|
*/
|
|
public static function formRule($fields, $files, $form) {
|
|
$errors = array();
|
|
|
|
if (empty($fields['contribution_date_high']) || empty($fields['contribution_date_low'])) {
|
|
return TRUE;
|
|
}
|
|
|
|
CRM_Utils_Rule::validDateRange($fields, 'contribution_date', $errors, ts('Date Received'));
|
|
|
|
return empty($errors) ? TRUE : $errors;
|
|
}
|
|
|
|
/**
|
|
* Add the soft credit fields to the select fields.
|
|
*
|
|
* Extracted into separate function to improve readability of main select function.
|
|
*
|
|
* @param $query
|
|
*/
|
|
private static function addSoftCreditFields(&$query) {
|
|
$includeSoftCredits = self::isSoftCreditOptionEnabled($query->_params);
|
|
if (!empty($query->_returnProperties['contribution_soft_credit_name'])) {
|
|
if ($includeSoftCredits) {
|
|
$query->_select['contribution_soft_credit_name'] = "civicrm_contact_d.sort_name as contribution_soft_credit_name";
|
|
// also include contact id. Will help build hyperlinks
|
|
$query->_select['contribution_soft_credit_contact_id'] = "civicrm_contact_d.id as contribution_soft_credit_contact_id";
|
|
}
|
|
$query->_element['contribution_soft_credit_name'] = 1;
|
|
$query->_element['contribution_soft_credit_contact_id'] = 1;
|
|
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = 1;
|
|
$query->_tables['civicrm_contribution_soft_contact'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_soft_credit_contact_id'])) {
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = 1;
|
|
$query->_tables['civicrm_contribution_soft_contact'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_soft_credit_amount'])) {
|
|
if ($includeSoftCredits) {
|
|
$query->_select['contribution_soft_credit_amount'] = "civicrm_contribution_soft.amount as contribution_soft_credit_amount";
|
|
}
|
|
$query->_element['contribution_soft_credit_amount'] = 1;
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_soft_credit_type'])) {
|
|
if ($includeSoftCredits) {
|
|
$query->_select['contribution_soft_credit_type'] = "contribution_softcredit_type.label as contribution_soft_credit_type";
|
|
}
|
|
$query->_element['contribution_soft_credit_type'] = 1;
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['contribution_softcredit_type'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_soft_credit_contribution_id'])) {
|
|
if ($includeSoftCredits) {
|
|
$query->_select['contribution_soft_credit_contribution_id'] = "civicrm_contribution_soft.contribution_id as contribution_soft_credit_contribution_id";
|
|
}
|
|
$query->_element['contribution_soft_credit_contribution_id'] = 1;
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_soft_credit_email'])) {
|
|
$query->_select['contribution_soft_credit_email'] = "soft_email.email as contribution_soft_credit_email";
|
|
$query->_element['contribution_soft_credit_email'] = 1;
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = 1;
|
|
$query->_tables['civicrm_contribution_soft_contact'] = 1;
|
|
$query->_tables['civicrm_contribution_soft_email'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_soft_credit_phone'])) {
|
|
$query->_select['contribution_soft_credit_email'] = "soft_phone.phone as contribution_soft_credit_phone";
|
|
$query->_element['contribution_soft_credit_phone'] = 1;
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = 1;
|
|
$query->_tables['civicrm_contribution_soft_contact'] = 1;
|
|
$query->_tables['civicrm_contribution_soft_phone'] = 1;
|
|
}
|
|
|
|
if (!empty($query->_returnProperties['contribution_soft_credit_pcp_id'])) {
|
|
$query->_select['contribution_soft_credit_pcp_id'] = "civicrm_contribution_soft.pcp_id as contribution_soft_credit_pcp_id";
|
|
$query->_element['contribution_soft_credit_pcp_id'] = 1;
|
|
$query->_tables['civicrm_contribution'] = 1;
|
|
$query->_tables['civicrm_contribution_soft'] = 1;
|
|
}
|
|
}
|
|
|
|
}
|