From 6c2c0ef10323d9479effdcfd2eddcee0279757f3 Mon Sep 17 00:00:00 2001
From: Monish Deb <deb.monish@gmail.com>
Date: Mon, 1 Jun 2020 21:00:44 +0530
Subject: [PATCH 1/2] Add Columns to Contribution Detail Report
---
CRM/Report/Form/Contribute/Detail.php | 1145 +++++++++++++++++++++++++
1 file changed, 1145 insertions(+)
create mode 100644 CRM/Report/Form/Contribute/Detail.php
diff --git a/CRM/Report/Form/Contribute/Detail.php b/CRM/Report/Form/Contribute/Detail.php
new file mode 100644
index 0000000..dea1087
--- /dev/null
+++ b/CRM/Report/Form/Contribute/Detail.php
@@ -0,0 +1,1145 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+class CRM_Report_Form_Contribute_Detail extends CRM_Report_Form {
+
+ protected $_summary = NULL;
+
+ protected $_softFrom = NULL;
+
+ protected $noDisplayContributionOrSoftColumn = FALSE;
+
+ protected $_customGroupExtends = [
+ 'Contact',
+ 'Individual',
+ 'Contribution',
+ ];
+
+ protected $groupConcatTested = TRUE;
+
+ protected $isTempTableBuilt = FALSE;
+
+ /**
+ * Query mode.
+ *
+ * This can be 'Main' or 'SoftCredit' to denote which query we are building.
+ *
+ * @var string
+ */
+ protected $queryMode = 'Main';
+
+ /**
+ * Is this report being run on contributions as the base entity.
+ *
+ * The report structure is generally designed around a base entity but
+ * depending on input it can be run in a sort of hybrid way that causes a lot
+ * of complexity.
+ *
+ * If it is in isContributionsOnlyMode we can simplify.
+ *
+ * (arguably there should be 2 separate report templates, not one doing double duty.)
+ *
+ * @var bool
+ */
+ protected $isContributionBaseMode = FALSE;
+
+ /**
+ * This report has been optimised for group filtering.
+ *
+ * CRM-19170
+ *
+ * @var bool
+ */
+ protected $groupFilterNotOptimised = FALSE;
+
+ /**
+ * Class constructor.
+ */
+ public function __construct() {
+ $this->_autoIncludeIndexedFieldsAsOrderBys = 1;
+ $this->_columns = array_merge(
+ $this->getColumns('Contact', [
+ 'order_bys_defaults' => ['sort_name' => 'ASC '],
+ 'fields_defaults' => ['sort_name'],
+ 'fields_excluded' => ['id'],
+ 'fields_required' => ['id'],
+ 'filters_defaults' => ['is_deleted' => 0],
+ 'no_field_disambiguation' => TRUE,
+ ]),
+ [
+ 'civicrm_email' => [
+ 'dao' => 'CRM_Core_DAO_Email',
+ 'fields' => [
+ 'email' => [
+ 'title' => ts('Donor Email'),
+ 'default' => TRUE,
+ ],
+ ],
+ 'grouping' => 'contact-fields',
+ ],
+ 'civicrm_line_item' => [
+ 'dao' => 'CRM_Price_DAO_LineItem',
+ ],
+ 'civicrm_phone' => [
+ 'dao' => 'CRM_Core_DAO_Phone',
+ 'fields' => [
+ 'phone' => [
+ 'title' => ts('Donor Phone'),
+ 'default' => TRUE,
+ 'no_repeat' => TRUE,
+ ],
+ ],
+ 'grouping' => 'contact-fields',
+ ],
+ 'civicrm_contribution' => [
+ 'dao' => 'CRM_Contribute_DAO_Contribution',
+ 'fields' => [
+ 'contribution_id' => [
+ 'name' => 'id',
+ 'no_display' => TRUE,
+ 'required' => TRUE,
+ ],
+ 'group_id' => [
+ 'dbAlias' => 'group_temp_table.group_id',
+ 'title' => ts('Group(s)'),
+ ],
+ 'list_contri_id' => [
+ 'name' => 'id',
+ 'title' => ts('Contribution ID'),
+ ],
+ 'financial_type_id' => [
+ 'title' => ts('Financial Type'),
+ 'default' => TRUE,
+ ],
+ 'contribution_status_id' => [
+ 'title' => ts('Contribution Status'),
+ ],
+ 'contribution_page_id' => [
+ 'title' => ts('Contribution Page'),
+ ],
+ 'source' => [
+ 'title' => ts('Source'),
+ ],
+ 'payment_instrument_id' => [
+ 'title' => ts('Payment Type'),
+ ],
+ 'check_number' => [
+ 'title' => ts('Check Number'),
+ ],
+ 'currency' => [
+ 'required' => TRUE,
+ 'no_display' => TRUE,
+ ],
+ 'trxn_id' => NULL,
+ 'receive_date' => ['default' => TRUE],
+ 'receipt_date' => NULL,
+ 'thankyou_date' => NULL,
+ 'total_amount' => [
+ 'title' => ts('Amount'),
+ 'required' => TRUE,
+ ],
+ 'non_deductible_amount' => [
+ 'title' => ts('Non-deductible Amount'),
+ ],
+ 'fee_amount' => NULL,
+ 'net_amount' => NULL,
+ 'contribution_or_soft' => [
+ 'title' => ts('Contribution OR Soft Credit?'),
+ 'dbAlias' => "'Contribution'",
+ ],
+ 'soft_credits' => [
+ 'title' => ts('Soft Credits'),
+ 'dbAlias' => "NULL",
+ ],
+ 'soft_credit_for' => [
+ 'title' => ts('Soft Credit For'),
+ 'dbAlias' => "NULL",
+ ],
+ 'cancel_date' => [
+ 'title' => ts('Cancelled / Refunded Date'),
+ 'name' => 'contribution_cancel_date',
+ ],
+ 'cancel_reason' => [
+ 'title' => ts('Cancellation / Refund Reason'),
+ ],
+ ],
+ 'filters' => [
+ 'contribution_or_soft' => [
+ 'title' => ts('Contribution OR Soft Credit?'),
+ 'clause' => "(1)",
+ 'operatorType' => CRM_Report_Form::OP_SELECT,
+ 'type' => CRM_Utils_Type::T_STRING,
+ 'options' => [
+ 'contributions_only' => ts('Contributions Only'),
+ 'soft_credits_only' => ts('Soft Credits Only'),
+ 'both' => ts('Both'),
+ ],
+ ],
+ 'group_id' => [
+ 'name' => 'group_id',
+ 'title' => ts('Group(s)'),
+ 'type' => CRM_Utils_Type::T_INT,
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Core_PseudoConstant::nestedGroup(),
+ ],
+ 'receive_date' => ['operatorType' => CRM_Report_Form::OP_DATE],
+ 'thankyou_date' => ['operatorType' => CRM_Report_Form::OP_DATE],
+ 'contribution_source' => [
+ 'title' => ts('Source'),
+ 'name' => 'source',
+ 'type' => CRM_Utils_Type::T_STRING,
+ ],
+ 'currency' => [
+ 'title' => ts('Currency'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Core_OptionGroup::values('currencies_enabled'),
+ 'default' => NULL,
+ 'type' => CRM_Utils_Type::T_STRING,
+ ],
+ 'non_deductible_amount' => [
+ 'title' => ts('Non-deductible Amount'),
+ ],
+ 'financial_type_id' => [
+ 'title' => ts('Financial Type'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes(),
+ 'type' => CRM_Utils_Type::T_INT,
+ ],
+ 'contribution_page_id' => [
+ 'title' => ts('Contribution Page'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Contribute_PseudoConstant::contributionPage(),
+ 'type' => CRM_Utils_Type::T_INT,
+ ],
+ 'payment_instrument_id' => [
+ 'title' => ts('Payment Type'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Contribute_PseudoConstant::paymentInstrument(),
+ 'type' => CRM_Utils_Type::T_INT,
+ ],
+ 'contribution_status_id' => [
+ 'title' => ts('Contribution Status'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Contribute_BAO_Contribution::buildOptions('contribution_status_id', 'search'),
+ 'default' => [1],
+ 'type' => CRM_Utils_Type::T_INT,
+ ],
+ 'total_amount' => ['title' => ts('Contribution Amount')],
+ 'cancel_date' => [
+ 'title' => ts('Cancelled / Refunded Date'),
+ 'operatorType' => CRM_Report_Form::OP_DATE,
+ 'name' => 'contribution_cancel_date',
+ ],
+ 'cancel_reason' => [
+ 'title' => ts('Cancellation / Refund Reason'),
+ ],
+ ],
+ 'order_bys' => [
+ 'financial_type_id' => ['title' => ts('Financial Type')],
+ 'contribution_status_id' => ['title' => ts('Contribution Status')],
+ 'payment_instrument_id' => ['title' => ts('Payment Method')],
+ 'receive_date' => ['title' => ts('Date Received')],
+ 'thankyou_date' => ['title' => ts('Thank-you Date')],
+ ],
+ 'group_bys' => [
+ 'contribution_id' => [
+ 'name' => 'id',
+ 'required' => TRUE,
+ 'default' => TRUE,
+ 'title' => ts('Contribution'),
+ ],
+ ],
+ 'grouping' => 'contri-fields',
+ ],
+ 'civicrm_contribution_soft' => [
+ 'dao' => 'CRM_Contribute_DAO_ContributionSoft',
+ 'fields' => [
+ 'soft_credit_type_id' => ['title' => ts('Soft Credit Type')],
+ 'soft_credit_amount' => ['title' => ts('Soft Credit amount'), 'name' => 'amount', 'type' => CRM_Utils_Type::T_MONEY],
+ ],
+ 'filters' => [
+ 'soft_credit_type_id' => [
+ 'title' => ts('Soft Credit Type'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Core_OptionGroup::values('soft_credit_type'),
+ 'default' => NULL,
+ 'type' => CRM_Utils_Type::T_STRING,
+ ],
+ ],
+ 'group_bys' => [
+ 'soft_credit_id' => [
+ 'name' => 'id',
+ 'title' => ts('Soft Credit'),
+ ],
+ ],
+ ],
+ 'civicrm_financial_trxn' => [
+ 'dao' => 'CRM_Financial_DAO_FinancialTrxn',
+ 'fields' => [
+ 'card_type_id' => [
+ 'title' => ts('Credit Card Type'),
+ ],
+ ],
+ 'filters' => [
+ 'card_type_id' => [
+ 'title' => ts('Credit Card Type'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Financial_DAO_FinancialTrxn::buildOptions('card_type_id'),
+ 'default' => NULL,
+ 'type' => CRM_Utils_Type::T_STRING,
+ ],
+ ],
+ ],
+ 'civicrm_batch' => [
+ 'dao' => 'CRM_Batch_DAO_EntityBatch',
+ 'grouping' => 'contri-fields',
+ 'fields' => [
+ 'batch_id' => [
+ 'name' => 'batch_id',
+ 'title' => ts('Batch Name'),
+ ],
+ ],
+ 'filters' => [
+ 'bid' => [
+ 'title' => ts('Batch Name'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Batch_BAO_Batch::getBatches(),
+ 'type' => CRM_Utils_Type::T_INT,
+ 'dbAlias' => 'batch_civireport.batch_id',
+ ],
+ ],
+ ],
+ 'civicrm_contribution_ordinality' => [
+ 'dao' => 'CRM_Contribute_DAO_Contribution',
+ 'alias' => 'cordinality',
+ 'filters' => [
+ 'ordinality' => [
+ 'title' => ts('Contribution Ordinality'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => [
+ 0 => 'First by Contributor',
+ 1 => 'Second or Later by Contributor',
+ ],
+ 'type' => CRM_Utils_Type::T_INT,
+ ],
+ ],
+ ],
+ 'cdntaxreceipts_log' => [
+ 'fields' => [
+ 'receipt_no' => [
+ 'title' => ts('Tax Receipt Number'),
+ ],
+ 'issued_on' => [
+ 'title' => ts('Tax Receipt Issued Date'),
+ 'dbAlias' => "DATE_FORMAT(FROM_UNIXTIME(issued_on), '%Y-%m-%d %H:%i:%s')",
+ ],
+ 'statistics' => FALSE,
+ ],
+ 'filters' => [
+ 'receipt_no' => [
+ 'title' => ts('Tax Receipt Number'),
+ 'name' => 'receipt_no',
+ 'type' => CRM_Utils_Type::T_STRING,
+ ],
+ 'issued_on' => [
+ 'title' => ts('Issued On'),
+ 'operatorType' => CRM_Report_Form::OP_DATE,
+ ],
+ ],
+ ],
+ 'civicrm_note' => [
+ 'dao' => 'CRM_Core_DAO_Note',
+ 'fields' => [
+ 'contribution_note' => [
+ 'name' => 'note',
+ 'title' => ts('Contribution Note'),
+ ],
+ ],
+ 'filters' => [
+ 'note' => [
+ 'name' => 'note',
+ 'title' => ts('Contribution Note'),
+ 'operator' => 'like',
+ 'type' => CRM_Utils_Type::T_STRING,
+ ],
+ ],
+ ],
+ 'civicrm_group' => [
+ 'dao' => 'CRM_Contact_DAO_Group',
+ 'fields' => [
+ 'title' => [
+ 'title' => ts('Group(s)'),
+ 'name' => 'title',
+ ],
+ 'id' => [
+ 'no_display' => TRUE,
+ ],
+ ],
+ ],
+ ],
+ $this->getColumns('Address')
+ );
+ // The tests test for this variation of the sort_name field. Don't argue with the tests :-).
+ $this->_columns['civicrm_contact']['fields']['sort_name']['title'] = ts('Donor Name');
+
+ $this->_groupFilter = TRUE;
+ $this->_tagFilter = TRUE;
+ // If we have campaigns enabled, add those elements to both the fields, filters and sorting
+ $this->addCampaignFields('civicrm_contribution', FALSE, TRUE);
+
+ $this->_currencyColumn = 'civicrm_contribution_currency';
+ parent::__construct();
+ unset($this->_columns['civicrm_group']['filters']['gid']);
+ }
+
+ /**
+ * Validate incompatible report settings.
+ *
+ * @return bool
+ * true if no error found
+ */
+ public function validate() {
+ // If you're displaying Contributions Only, you can't group by soft credit.
+ $contributionOrSoftVal = $this->getElementValue('contribution_or_soft_value');
+ if ($contributionOrSoftVal[0] == 'contributions_only') {
+ $groupBySoft = $this->getElementValue('group_bys');
+ if (!empty($groupBySoft['soft_credit_id'])) {
+ $this->setElementError('group_bys', ts('You cannot group by soft credit when displaying contributions only. Please uncheck "Soft Credit" in the Grouping tab.'));
+ }
+ }
+
+ return parent::validate();
+ }
+
+ /**
+ * Set the FROM clause for the report.
+ */
+ public function from() {
+ $groupTable = $this->buildGroupTempTable();
+ $filteredGroups = (array) $this->_params['group_id_value'];
+ $side = empty($filteredGroups) ? 'LEFT' : 'INNER';
+
+ $this->setFromBase('civicrm_contact');
+ $this->_from .= "
+ INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
+ ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution']}.contact_id
+ AND {$this->_aliases['civicrm_contribution']}.is_test = 0
+ $side JOIN $groupTable group_temp_table ON {$this->_aliases['civicrm_contact']}.id = group_temp_table.contact_id
+ ";
+
+ $this->joinContributionToSoftCredit();
+ $this->appendAdditionalFromJoins();
+ }
+
+
+ /**
+ * @param $rows
+ *
+ * @return array
+ */
+ public function statistics(&$rows) {
+ $statistics = parent::statistics($rows);
+
+ $totalAmount = $average = $fees = $net = [];
+ $count = 0;
+ $select = "
+ SELECT COUNT({$this->_aliases['civicrm_contribution']}.total_amount ) as count,
+ SUM( {$this->_aliases['civicrm_contribution']}.total_amount ) as amount,
+ ROUND(AVG({$this->_aliases['civicrm_contribution']}.total_amount), 2) as avg,
+ {$this->_aliases['civicrm_contribution']}.currency as currency,
+ SUM( {$this->_aliases['civicrm_contribution']}.fee_amount ) as fees,
+ SUM( {$this->_aliases['civicrm_contribution']}.net_amount ) as net
+ ";
+
+ $group = "\nGROUP BY {$this->_aliases['civicrm_contribution']}.currency";
+ $sql = "{$select} {$this->_from} {$this->_where} {$group}";
+ $dao = CRM_Core_DAO::executeQuery($sql);
+ $this->addToDeveloperTab($sql);
+
+ while ($dao->fetch()) {
+ $totalAmount[] = CRM_Utils_Money::format($dao->amount, $dao->currency) . " (" . $dao->count . ")";
+ $fees[] = CRM_Utils_Money::format($dao->fees, $dao->currency);
+ $net[] = CRM_Utils_Money::format($dao->net, $dao->currency);
+ $average[] = CRM_Utils_Money::format($dao->avg, $dao->currency);
+ $count += $dao->count;
+ }
+ $statistics['counts']['amount'] = [
+ 'title' => ts('Total Amount (Contributions)'),
+ 'value' => implode(', ', $totalAmount),
+ 'type' => CRM_Utils_Type::T_STRING,
+ ];
+ $statistics['counts']['count'] = [
+ 'title' => ts('Total Contributions'),
+ 'value' => $count,
+ ];
+ $statistics['counts']['fees'] = [
+ 'title' => ts('Fees'),
+ 'value' => implode(', ', $fees),
+ 'type' => CRM_Utils_Type::T_STRING,
+ ];
+ $statistics['counts']['net'] = [
+ 'title' => ts('Net'),
+ 'value' => implode(', ', $net),
+ 'type' => CRM_Utils_Type::T_STRING,
+ ];
+ $statistics['counts']['avg'] = [
+ 'title' => ts('Average'),
+ 'value' => implode(', ', $average),
+ 'type' => CRM_Utils_Type::T_STRING,
+ ];
+
+ // Stats for soft credits
+ if ($this->_softFrom &&
+ CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) !=
+ 'contributions_only'
+ ) {
+ $totalAmount = $average = [];
+ $count = 0;
+ $select = "
+SELECT COUNT(contribution_soft_civireport.amount ) as count,
+ SUM(contribution_soft_civireport.amount ) as amount,
+ ROUND(AVG(contribution_soft_civireport.amount), 2) as avg,
+ {$this->_aliases['civicrm_contribution']}.currency as currency";
+ $sql = "
+{$select}
+{$this->_softFrom}
+GROUP BY {$this->_aliases['civicrm_contribution']}.currency";
+ $dao = CRM_Core_DAO::executeQuery($sql);
+ $this->addToDeveloperTab($sql);
+ while ($dao->fetch()) {
+ $totalAmount[] = CRM_Utils_Money::format($dao->amount, $dao->currency) . " (" .
+ $dao->count . ")";
+ $average[] = CRM_Utils_Money::format($dao->avg, $dao->currency);
+ $count += $dao->count;
+ }
+ $statistics['counts']['softamount'] = [
+ 'title' => ts('Total Amount (Soft Credits)'),
+ 'value' => implode(', ', $totalAmount),
+ 'type' => CRM_Utils_Type::T_STRING,
+ ];
+ $statistics['counts']['softcount'] = [
+ 'title' => ts('Total Soft Credits'),
+ 'value' => $count,
+ ];
+ $statistics['counts']['softavg'] = [
+ 'title' => ts('Average (Soft Credits)'),
+ 'value' => implode(', ', $average),
+ 'type' => CRM_Utils_Type::T_STRING,
+ ];
+ }
+
+ return $statistics;
+ }
+
+ /**
+ * Build the report query.
+ *
+ * @param bool $applyLimit
+ *
+ * @return string
+ */
+ public function buildQuery($applyLimit = FALSE) {
+ if ($this->isTempTableBuilt) {
+ $this->limit();
+ return "SELECT SQL_CALC_FOUND_ROWS * FROM {$this->temporaryTables['civireport_contribution_detail_temp3']['name']} $this->_orderBy $this->_limit";
+ }
+ return parent::buildQuery($applyLimit);
+ }
+
+ /**
+ * Shared function for preliminary processing.
+ *
+ * This is called by the api / unit tests and the form layer and is
+ * the right place to do 'initial analysis of input'.
+ */
+ public function beginPostProcessCommon() {
+ // CRM-18312 - display soft_credits and soft_credits_for column
+ // when 'Contribution or Soft Credit?' column is not selected
+ if (empty($this->_params['fields']['contribution_or_soft'])) {
+ $this->_params['fields']['contribution_or_soft'] = 1;
+ $this->noDisplayContributionOrSoftColumn = TRUE;
+ }
+
+ if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params, 'contributions_only') == 'contributions_only') {
+ $this->isContributionBaseMode = TRUE;
+ }
+ if ($this->isContributionBaseMode &&
+ (!empty($this->_params['fields']['soft_credit_type_id'])
+ || !empty($this->_params['soft_credit_type_id_value']))
+ ) {
+ unset($this->_params['fields']['soft_credit_type_id']);
+ if (!empty($this->_params['soft_credit_type_id_value'])) {
+ $this->_params['soft_credit_type_id_value'] = [];
+ CRM_Core_Session::setStatus(ts('Is it not possible to filter on soft contribution type when not including soft credits.'));
+ }
+ }
+ // 1. use main contribution query to build temp table 1
+ $sql = $this->buildQuery();
+ $this->createTemporaryTable('civireport_contribution_detail_temp1', $sql);
+
+ // 2. customize main contribution query for soft credit, and build temp table 2 with soft credit contributions only
+ $this->queryMode = 'SoftCredit';
+ // Rebuild select with no groupby. Do not let column headers change.
+ $headers = $this->_columnHeaders;
+ $this->select();
+ $this->_columnHeaders = $headers;
+ $this->softCreditFrom();
+ // also include custom group from if included
+ // since this might be included in select
+ $this->customDataFrom();
+
+ $select = str_ireplace('contribution_civireport.total_amount', 'contribution_soft_civireport.amount', $this->_select);
+ $select = str_ireplace("'Contribution' as", "'Soft Credit' as", $select);
+
+ // we inner join with temp1 to restrict soft contributions to those in temp1 table.
+ // no group by here as we want to display as many soft credit rows as actually exist.
+ $sql = "{$select} {$this->_from} {$this->_where} $this->_groupBy";
+ $this->createTemporaryTable('civireport_contribution_detail_temp2', $sql);
+
+ if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
+ 'soft_credits_only'
+ ) {
+ // revise pager : prev, next based on soft-credits only
+ $this->setPager();
+ }
+
+ // copy _from for later use of stats calculation for soft credits, and reset $this->_from to main query
+ $this->_softFrom = $this->_from;
+
+ // simple reset of ->_from
+ $this->from();
+
+ // also include custom group from if included
+ // since this might be included in select
+ $this->customDataFrom();
+
+ // 3. Decide where to populate temp3 table from
+ if ($this->isContributionBaseMode
+ ) {
+ $this->createTemporaryTable('civireport_contribution_detail_temp3',
+ "(SELECT * FROM {$this->temporaryTables['civireport_contribution_detail_temp1']['name']})"
+ );
+ }
+ elseif (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
+ 'soft_credits_only'
+ ) {
+ $this->createTemporaryTable('civireport_contribution_detail_temp3',
+ "(SELECT * FROM {$this->temporaryTables['civireport_contribution_detail_temp2']['name']})"
+ );
+ }
+ else {
+ $this->createTemporaryTable('civireport_contribution_detail_temp3', "
+(SELECT * FROM {$this->temporaryTables['civireport_contribution_detail_temp1']['name']})
+UNION ALL
+(SELECT * FROM {$this->temporaryTables['civireport_contribution_detail_temp2']['name']})");
+ }
+ $this->isTempTableBuilt = TRUE;
+ }
+
+ /**
+ * Store group bys into array - so we can check elsewhere what is grouped.
+ *
+ * If we are generating a table of soft credits we need to group by them.
+ */
+ protected function storeGroupByArray() {
+ if ($this->queryMode === 'SoftCredit') {
+ $this->_groupByArray = [$this->_aliases['civicrm_contribution_soft'] . '.id'];
+ }
+ else {
+ parent::storeGroupByArray();
+ }
+ }
+
+ /**
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
+ */
+ public function alterDisplay(&$rows) {
+ $entryFound = FALSE;
+ $display_flag = $prev_cid = $cid = 0;
+ $contributionTypes = CRM_Contribute_PseudoConstant::financialType();
+ $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'label');
+ $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument();
+ $contributionPages = CRM_Contribute_PseudoConstant::contributionPage();
+ $batches = CRM_Batch_BAO_Batch::getBatches();
+ foreach ($rows as $rowNum => $row) {
+ if (!empty($this->_noRepeats) && $this->_outputMode != 'csv') {
+ // don't repeat contact details if its same as the previous row
+ if (array_key_exists('civicrm_contact_id', $row)) {
+ if ($cid = $row['civicrm_contact_id']) {
+ if ($rowNum == 0) {
+ $prev_cid = $cid;
+ }
+ else {
+ if ($prev_cid == $cid) {
+ $display_flag = 1;
+ $prev_cid = $cid;
+ }
+ else {
+ $display_flag = 0;
+ $prev_cid = $cid;
+ }
+ }
+
+ if ($display_flag) {
+ foreach ($row as $colName => $colVal) {
+ // Hide repeats in no-repeat columns, but not if the field's a section header
+ if (in_array($colName, $this->_noRepeats) &&
+ !array_key_exists($colName, $this->_sections)
+ ) {
+ unset($rows[$rowNum][$colName]);
+ }
+ }
+ }
+ $entryFound = TRUE;
+ }
+ }
+ }
+
+ if (CRM_Utils_Array::value('civicrm_contribution_contribution_or_soft', $rows[$rowNum]) ==
+ 'Contribution'
+ ) {
+ unset($rows[$rowNum]['civicrm_contribution_soft_soft_credit_type_id']);
+ }
+
+ $entryFound = $this->alterDisplayContactFields($row, $rows, $rowNum, 'contribution/detail', ts('View Contribution Details')) ? TRUE : $entryFound;
+ // convert donor sort name to link
+ if (array_key_exists('civicrm_contact_sort_name', $row) &&
+ !empty($rows[$rowNum]['civicrm_contact_sort_name']) &&
+ array_key_exists('civicrm_contact_id', $row)
+ ) {
+ $url = CRM_Utils_System::url("civicrm/contact/view",
+ 'reset=1&cid=' . $row['civicrm_contact_id'],
+ $this->_absoluteUrl
+ );
+ $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
+ $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact Summary for this Contact.");
+ }
+
+ if ($value = CRM_Utils_Array::value('civicrm_contribution_financial_type_id', $row)) {
+ $rows[$rowNum]['civicrm_contribution_financial_type_id'] = $contributionTypes[$value];
+ $entryFound = TRUE;
+ }
+ if ($value = CRM_Utils_Array::value('civicrm_contribution_contribution_status_id', $row)) {
+ $rows[$rowNum]['civicrm_contribution_contribution_status_id'] = $contributionStatus[$value];
+ $entryFound = TRUE;
+ }
+ if ($value = CRM_Utils_Array::value('civicrm_contribution_contribution_page_id', $row)) {
+ $rows[$rowNum]['civicrm_contribution_contribution_page_id'] = $contributionPages[$value];
+ $entryFound = TRUE;
+ }
+ if ($value = CRM_Utils_Array::value('civicrm_contribution_payment_instrument_id', $row)) {
+ $rows[$rowNum]['civicrm_contribution_payment_instrument_id'] = $paymentInstruments[$value];
+ $entryFound = TRUE;
+ }
+ if (!empty($row['civicrm_batch_batch_id'])) {
+ $rows[$rowNum]['civicrm_batch_batch_id'] = CRM_Utils_Array::value($row['civicrm_batch_batch_id'], $batches);
+ $entryFound = TRUE;
+ }
+ if (!empty($row['civicrm_financial_trxn_card_type_id'])) {
+ $rows[$rowNum]['civicrm_financial_trxn_card_type_id'] = $this->getLabels($row['civicrm_financial_trxn_card_type_id'], 'CRM_Financial_DAO_FinancialTrxn', 'card_type_id');
+ $entryFound = TRUE;
+ }
+
+ // Contribution amount links to viewing contribution
+ if ($value = CRM_Utils_Array::value('civicrm_contribution_total_amount', $row)) {
+ $rows[$rowNum]['civicrm_contribution_total_amount'] = CRM_Utils_Money::format($value, $row['civicrm_contribution_currency']);
+ if (CRM_Core_Permission::check('access CiviContribute')) {
+ $url = CRM_Utils_System::url(
+ "civicrm/contact/view/contribution",
+ [
+ 'reset' => 1,
+ 'id' => $row['civicrm_contribution_contribution_id'],
+ 'cid' => $row['civicrm_contact_id'],
+ 'action' => 'view',
+ 'context' => 'contribution',
+ 'selectedChild' => 'contribute',
+ ],
+ $this->_absoluteUrl
+ );
+ $rows[$rowNum]['civicrm_contribution_total_amount_link'] = $url;
+ $rows[$rowNum]['civicrm_contribution_total_amount_hover'] = ts("View Details of this Contribution.");
+ }
+ $entryFound = TRUE;
+ }
+
+ // convert campaign_id to campaign title
+ if (array_key_exists('civicrm_contribution_campaign_id', $row)) {
+ if ($value = $row['civicrm_contribution_campaign_id']) {
+ $rows[$rowNum]['civicrm_contribution_campaign_id'] = $this->campaigns[$value];
+ $entryFound = TRUE;
+ }
+ }
+
+ // soft credits
+ if (array_key_exists('civicrm_contribution_soft_credits', $row) &&
+ 'Contribution' ==
+ CRM_Utils_Array::value('civicrm_contribution_contribution_or_soft', $rows[$rowNum]) &&
+ array_key_exists('civicrm_contribution_contribution_id', $row)
+ ) {
+ $query = "
+SELECT civicrm_contact_id, civicrm_contact_sort_name, civicrm_contribution_total_amount, civicrm_contribution_currency
+FROM {$this->temporaryTables['civireport_contribution_detail_temp2']['name']}
+WHERE civicrm_contribution_contribution_id={$row['civicrm_contribution_contribution_id']}";
+ $dao = CRM_Core_DAO::executeQuery($query);
+ $string = '';
+ $separator = ($this->_outputMode !== 'csv') ? "<br/>" : ' ';
+ while ($dao->fetch()) {
+ $url = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' .
+ $dao->civicrm_contact_id);
+ $string = $string . ($string ? $separator : '') .
+ "<a href='{$url}'>{$dao->civicrm_contact_sort_name}</a> " .
+ CRM_Utils_Money::format($dao->civicrm_contribution_total_amount, $dao->civicrm_contribution_currency);
+ }
+ $rows[$rowNum]['civicrm_contribution_soft_credits'] = $string;
+ }
+
+ if (array_key_exists('civicrm_contribution_soft_credit_for', $row) &&
+ 'Soft Credit' ==
+ CRM_Utils_Array::value('civicrm_contribution_contribution_or_soft', $rows[$rowNum]) &&
+ array_key_exists('civicrm_contribution_contribution_id', $row)
+ ) {
+ $query = "
+SELECT civicrm_contact_id, civicrm_contact_sort_name
+FROM {$this->temporaryTables['civireport_contribution_detail_temp1']['name']}
+WHERE civicrm_contribution_contribution_id={$row['civicrm_contribution_contribution_id']}";
+ $dao = CRM_Core_DAO::executeQuery($query);
+ $string = '';
+ while ($dao->fetch()) {
+ $url = CRM_Utils_System::url("civicrm/contact/view", 'reset=1&cid=' .
+ $dao->civicrm_contact_id);
+ $string = $string .
+ "\n<a href='{$url}'>{$dao->civicrm_contact_sort_name}</a>";
+ }
+ $rows[$rowNum]['civicrm_contribution_soft_credit_for'] = $string;
+ }
+
+ // CRM-18312 - hide 'contribution_or_soft' column if unchecked.
+ if (!empty($this->noDisplayContributionOrSoftColumn)) {
+ unset($rows[$rowNum]['civicrm_contribution_contribution_or_soft']);
+ unset($this->_columnHeaders['civicrm_contribution_contribution_or_soft']);
+ }
+
+ //convert soft_credit_type_id into label
+ if (array_key_exists('civicrm_contribution_soft_soft_credit_type_id', $rows[$rowNum])) {
+ $rows[$rowNum]['civicrm_contribution_soft_soft_credit_type_id'] = CRM_Core_PseudoConstant::getLabel(
+ 'CRM_Contribute_BAO_ContributionSoft',
+ 'soft_credit_type_id',
+ $row['civicrm_contribution_soft_soft_credit_type_id']
+ );
+ }
+
+ $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s) for this ') ? TRUE : $entryFound;
+
+ // skip looking further in rows, if first row itself doesn't
+ // have the column we need
+ if (!$entryFound) {
+ break;
+ }
+ $lastKey = $rowNum;
+ }
+ }
+
+ public function sectionTotals() {
+
+ // Reports using order_bys with sections must populate $this->_selectAliases in select() method.
+ if (empty($this->_selectAliases)) {
+ return;
+ }
+
+ if (!empty($this->_sections)) {
+ // build the query with no LIMIT clause
+ $select = str_ireplace('SELECT SQL_CALC_FOUND_ROWS ', 'SELECT ', $this->_select);
+ $sql = "{$select} {$this->_from} {$this->_where} {$this->_groupBy} {$this->_having} {$this->_orderBy}";
+
+ // pull section aliases out of $this->_sections
+ $sectionAliases = array_keys($this->_sections);
+
+ $ifnulls = [];
+ foreach (array_merge($sectionAliases, $this->_selectAliases) as $alias) {
+ $ifnulls[] = "ifnull($alias, '') as $alias";
+ }
+ $this->_select = "SELECT " . implode(", ", $ifnulls);
+ $this->_select = CRM_Contact_BAO_Query::appendAnyValueToSelect($ifnulls, $sectionAliases);
+
+ /* Group (un-limited) report by all aliases and get counts. This might
+ * be done more efficiently when the contents of $sql are known, ie. by
+ * overriding this method in the report class.
+ */
+
+ $addtotals = '';
+
+ if (array_search("civicrm_contribution_total_amount", $this->_selectAliases) !==
+ FALSE
+ ) {
+ $addtotals = ", sum(civicrm_contribution_total_amount) as sumcontribs";
+ $showsumcontribs = TRUE;
+ }
+
+ $query = $this->_select .
+ "$addtotals, count(*) as ct from {$this->temporaryTables['civireport_contribution_detail_temp3']['name']} group by " .
+ implode(", ", $sectionAliases);
+ // initialize array of total counts
+ $sumcontribs = $totals = [];
+ $dao = CRM_Core_DAO::executeQuery($query);
+ $this->addToDeveloperTab($query);
+ while ($dao->fetch()) {
+
+ // let $this->_alterDisplay translate any integer ids to human-readable values.
+ $rows[0] = $dao->toArray();
+ $this->alterDisplay($rows);
+ $row = $rows[0];
+
+ // add totals for all permutations of section values
+ $values = [];
+ $i = 1;
+ $aliasCount = count($sectionAliases);
+ foreach ($sectionAliases as $alias) {
+ $values[] = $row[$alias];
+ $key = implode(CRM_Core_DAO::VALUE_SEPARATOR, $values);
+ if ($i == $aliasCount) {
+ // the last alias is the lowest-level section header; use count as-is
+ $totals[$key] = $dao->ct;
+ if ($showsumcontribs) {
+ $sumcontribs[$key] = $dao->sumcontribs;
+ }
+ }
+ else {
+ // other aliases are higher level; roll count into their total
+ $totals[$key] = (array_key_exists($key, $totals)) ? $totals[$key] + $dao->ct : $dao->ct;
+ if ($showsumcontribs) {
+ $sumcontribs[$key] = array_key_exists($key, $sumcontribs) ? $sumcontribs[$key] + $dao->sumcontribs : $dao->sumcontribs;
+ }
+ }
+ }
+ }
+ if ($showsumcontribs) {
+ $totalandsum = [];
+ // ts exception to avoid having ts("%1 %2: %3")
+ $title = '%1 contributions / soft-credits: %2';
+
+ if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
+ 'contributions_only'
+ ) {
+ $title = '%1 contributions: %2';
+ }
+ elseif (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) ==
+ 'soft_credits_only'
+ ) {
+ $title = '%1 soft-credits: %2';
+ }
+ foreach ($totals as $key => $total) {
+ $totalandsum[$key] = ts($title, [
+ 1 => $total,
+ 2 => CRM_Utils_Money::format($sumcontribs[$key]),
+ ]);
+ }
+ $this->assign('sectionTotals', $totalandsum);
+ }
+ else {
+ $this->assign('sectionTotals', $totals);
+ }
+ }
+ }
+
+ /**
+ * Generate the from clause as it relates to the soft credits.
+ */
+ public function softCreditFrom() {
+
+ $this->_from = "
+ FROM {$this->temporaryTables['civireport_contribution_detail_temp1']['name']} temp1_civireport
+ INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
+ ON temp1_civireport.civicrm_contribution_contribution_id = {$this->_aliases['civicrm_contribution']}.id
+ INNER JOIN civicrm_contribution_soft contribution_soft_civireport
+ ON contribution_soft_civireport.contribution_id = {$this->_aliases['civicrm_contribution']}.id
+ INNER JOIN civicrm_contact {$this->_aliases['civicrm_contact']}
+ ON {$this->_aliases['civicrm_contact']}.id = contribution_soft_civireport.contact_id
+ {$this->_aclFrom}
+ ";
+
+ //Join temp table if report is filtered by group. This is specific to 'notin' operator and covered in unit test(ref dev/core#212)
+ if (!empty($this->_params['gid_op']) && $this->_params['gid_op'] == 'notin') {
+ $this->joinGroupTempTable('civicrm_contact', 'id', $this->_aliases['civicrm_contact']);
+ }
+ $this->appendAdditionalFromJoins();
+ }
+
+ /**
+ * Append the joins that are required regardless of context.
+ */
+ public function appendAdditionalFromJoins() {
+ if (!empty($this->_params['ordinality_value'])) {
+ $this->_from .= "
+ INNER JOIN (SELECT c.id, IF(COUNT(oc.id) = 0, 0, 1) AS ordinality FROM civicrm_contribution c LEFT JOIN civicrm_contribution oc ON c.contact_id = oc.contact_id AND oc.receive_date < c.receive_date GROUP BY c.id) {$this->_aliases['civicrm_contribution_ordinality']}
+ ON {$this->_aliases['civicrm_contribution_ordinality']}.id = {$this->_aliases['civicrm_contribution']}.id";
+ }
+ $this->joinPhoneFromContact();
+ $this->joinAddressFromContact();
+ $this->joinEmailFromContact();
+
+ // include contribution note
+ if (!empty($this->_params['fields']['contribution_note']) ||
+ !empty($this->_params['note_value'])
+ ) {
+ $this->_from .= "
+ LEFT JOIN civicrm_note {$this->_aliases['civicrm_note']}
+ ON ( {$this->_aliases['civicrm_note']}.entity_table = 'civicrm_contribution' AND
+ {$this->_aliases['civicrm_contribution']}.id = {$this->_aliases['civicrm_note']}.entity_id )";
+ }
+ //for contribution batches
+ if (!empty($this->_params['fields']['batch_id']) ||
+ !empty($this->_params['bid_value'])
+ ) {
+ $this->_from .= "
+ LEFT JOIN civicrm_entity_financial_trxn eft
+ ON eft.entity_id = {$this->_aliases['civicrm_contribution']}.id AND
+ eft.entity_table = 'civicrm_contribution'
+ LEFT JOIN civicrm_entity_batch {$this->_aliases['civicrm_batch']}
+ ON ({$this->_aliases['civicrm_batch']}.entity_id = eft.financial_trxn_id
+ AND {$this->_aliases['civicrm_batch']}.entity_table = 'civicrm_financial_trxn')";
+ }
+ // JMA - Add join to tax receipt table
+ if (!empty($this->_params['fields']['issued_on']) ||
+ !empty($this->_params['fields']['receipt_no'])
+ ) {
+ $this->_from .= "
+ LEFT JOIN cdntaxreceipts_log_contributions cdn_con
+ ON cdn_con.contribution_id = {$this->_aliases['civicrm_contribution']}.id
+ LEFT JOIN cdntaxreceipts_log {$this->_aliases['cdntaxreceipts_log']}
+ ON {$this->_aliases['cdntaxreceipts_log']}.id = cdn_con.receipt_id";
+ }
+ // JMA - Add join to groups table
+ if (!empty($this->_params['fields']['title'])) {
+ $this->_from .= "
+ LEFT JOIN civicrm_group_contact cg
+ ON cg.contact_id = {$this->_aliases['civicrm_contact']}.id AND cg.status = 'Added'
+ LEFT JOIN civicrm_group {$this->_aliases['civicrm_group']}
+ ON {$this->_aliases['civicrm_group']}.id = cg.group_id";
+ }
+ // for credit card type
+ $this->addFinancialTrxnFromClause();
+ }
+
+ /**
+ * Add join to the soft credit table.
+ */
+ protected function joinContributionToSoftCredit() {
+ if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) == 'contributions_only'
+ && !$this->isTableSelected('civicrm_contribution_soft')) {
+ return;
+ }
+ $joinType = ' LEFT ';
+ if (CRM_Utils_Array::value('contribution_or_soft_value', $this->_params) == 'soft_credits_only') {
+ $joinType = ' INNER ';
+ }
+ $this->_from .= "
+ $joinType JOIN civicrm_contribution_soft {$this->_aliases['civicrm_contribution_soft']}
+ ON {$this->_aliases['civicrm_contribution_soft']}.contribution_id = {$this->_aliases['civicrm_contribution']}.id
+ ";
+ }
+
+ function where() {
+ $clauses = array();
+ foreach ($this->_columns as $tableName => $table) {
+ if (array_key_exists('filters', $table)) {
+ foreach ($table['filters'] as $fieldName => $field) {
+ if ($field['name'] == 'group_id') {
+ continue;
+ }
+ $clause = NULL;
+ if (CRM_Utils_Array::value('operatorType', $field) & CRM_Utils_Type::T_DATE) {
+ $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
+ $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
+ $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
+
+ $this->_dateClause = $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
+ }
+ else {
+ $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
+ if ($op) {
+ $clause = $this->whereClause($field,
+ $op,
+ CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
+ CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
+ CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
+ );
+ }
+ }
+
+ if (!empty($clause)) {
+ $clauses[] = $clause;
+ }
+ }
+ }
+ }
+
+ if (empty($clauses)) {
+ $this->_where = "WHERE ( 1 ) ";
+ }
+ else {
+ $this->_where = "WHERE " . implode(' AND ', $clauses);
+ }
+ }
+
+ /**
+ * Create a table of the contact ids included by the group filter.
+ *
+ * This function is called by both the api (tests) and the UI.
+ */
+ public function buildGroupTempTable() {
+ $filteredGroups = (array) $this->_params['group_id_value'];
+ $op = $this->_params['group_id_op'];
+
+
+ if (empty($filteredGroups) || in_array($op, ['nll', 'nnll'])) {
+ $where = ($op == 'nll') ? 'group_contact.group_id IS NOT NULL' : ($op = 'nnll') ? ' group_contact.group_id IS NULL ' : '(1)';
+ }
+ else {
+ $op = ($op == 'in') ? 'IN' : 'NOT IN';
+ $where = sprintf(' group_contact.group_id %s (%s)', $op, implode(', ', $filteredGroups));
+ }
+
+ $query = "
+ SELECT DISTINCT group_contact.contact_id, GROUP_CONCAT(DISTICT g.title) as group_id
+ FROM civicrm_group_contact group_contact
+ INNER JOIN civicrm_group g ON g.id = group_contact.group_id
+ WHERE {$where}
+ AND group_contact.status = 'Added'
+ GROUP BY smartgroup_contact.contact_id
+ ";
+
+ $where = str_replace('group_contact', 'smartgroup_contact', $where);
+ $query .= "
+ UNION DISTINCT
+ SELECT smartgroup_contact.contact_id, GROUP_CONCAT(DISTICT g.title) as group_id
+ FROM civicrm_group_contact_cache smartgroup_contact
+ INNER JOIN civicrm_group g ON g.id = smartgroup_contact.group_id
+ WHERE {$where}
+ GROUP BY smartgroup_contact.contact_id
+ ";
+
+ $groupTempTable = $this->createTemporaryTable('rptgrp', $query);
+ CRM_Core_DAO::executeQuery("ALTER TABLE $this->groupTempTable ADD INDEX i_id(contact_id)");
+ return $groupTempTable;
+ }
+
+}
--
GitLab
From ad5bc5960b02cb5d1ca5c6b02c13011be83b8328 Mon Sep 17 00:00:00 2001
From: Monish Deb <deb.monish@gmail.com>
Date: Tue, 2 Jun 2020 12:40:53 +0530
Subject: [PATCH 2/2] Add membership Detail report
---
CRM/Report/Form/Contribute/Detail.php | 35 +-
CRM/Report/Form/Member/Detail.php | 512 ++++++++++++++++++++++++++
2 files changed, 533 insertions(+), 14 deletions(-)
create mode 100644 CRM/Report/Form/Member/Detail.php
diff --git a/CRM/Report/Form/Contribute/Detail.php b/CRM/Report/Form/Contribute/Detail.php
index dea1087..902ed8c 100644
--- a/CRM/Report/Form/Contribute/Detail.php
+++ b/CRM/Report/Form/Contribute/Detail.php
@@ -144,7 +144,7 @@ class CRM_Report_Form_Contribute_Detail extends CRM_Report_Form {
'no_display' => TRUE,
],
'trxn_id' => NULL,
- 'receive_date' => ['default' => TRUE],
+ 'receive_date' => ['default' => TRUE, 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME],
'receipt_date' => NULL,
'thankyou_date' => NULL,
'total_amount' => [
@@ -344,6 +344,7 @@ class CRM_Report_Form_Contribute_Detail extends CRM_Report_Form {
],
'issued_on' => [
'title' => ts('Tax Receipt Issued Date'),
+ 'type' => CRM_Utils_Type::T_DATE + CRM_Utils_Type::T_TIME,
'dbAlias' => "DATE_FORMAT(FROM_UNIXTIME(issued_on), '%Y-%m-%d %H:%i:%s')",
],
'statistics' => FALSE,
@@ -355,8 +356,9 @@ class CRM_Report_Form_Contribute_Detail extends CRM_Report_Form {
'type' => CRM_Utils_Type::T_STRING,
],
'issued_on' => [
- 'title' => ts('Issued On'),
+ 'title' => ts('Tax Receipt Issued Date'),
'operatorType' => CRM_Report_Form::OP_DATE,
+ 'name' => "DATE_FORMAT(FROM_UNIXTIME(issued_on), '%Y%m%d%H%i%s')",
],
],
],
@@ -377,18 +379,6 @@ class CRM_Report_Form_Contribute_Detail extends CRM_Report_Form {
],
],
],
- 'civicrm_group' => [
- 'dao' => 'CRM_Contact_DAO_Group',
- 'fields' => [
- 'title' => [
- 'title' => ts('Group(s)'),
- 'name' => 'title',
- ],
- 'id' => [
- 'no_display' => TRUE,
- ],
- ],
- ],
],
$this->getColumns('Address')
);
@@ -847,6 +837,23 @@ WHERE civicrm_contribution_contribution_id={$row['civicrm_contribution_contribu
);
}
+ // Convert datetime values to custom date and time format
+ if ($this->_outputMode != 'csv') {
+ $dateFields = [
+ 'civicrm_contribution_receive_date',
+ 'cdntaxreceipts_log_issued_on',
+ ];
+
+ foreach ($dateFields as $dateField) {
+ if (array_key_exists($dateField, $row)) {
+ if (!empty($rows[$rowNum][$dateField])) {
+ $rows[$rowNum][$dateField] = CRM_Utils_Date::customFormat($row[$dateField], $config->dateformatDatetime);
+ }
+ $entryFound = TRUE;
+ }
+ }
+ }
+
$entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'contribute/detail', 'List all contribution(s) for this ') ? TRUE : $entryFound;
// skip looking further in rows, if first row itself doesn't
diff --git a/CRM/Report/Form/Member/Detail.php b/CRM/Report/Form/Member/Detail.php
new file mode 100644
index 0000000..b4b3a01
--- /dev/null
+++ b/CRM/Report/Form/Member/Detail.php
@@ -0,0 +1,512 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+class CRM_Report_Form_Member_Detail extends CRM_Report_Form {
+
+ protected $_summary = NULL;
+
+ protected $_customGroupExtends = [
+ 'Membership',
+ 'Contribution',
+ 'Contact',
+ 'Individual',
+ 'Household',
+ 'Organization',
+ ];
+
+ protected $_customGroupGroupBy = FALSE;
+
+ /**
+ * This report has not been optimised for group filtering.
+ *
+ * The functionality for group filtering has been improved but not
+ * all reports have been adjusted to take care of it. This report has not
+ * and will run an inefficient query until fixed.
+ *
+ * CRM-19170
+ *
+ * @var bool
+ */
+ protected $groupFilterNotOptimised = FALSE;
+
+ /**
+ * Class constructor.
+ */
+ public function __construct() {
+ $this->_columns = [
+ 'civicrm_contact' => [
+ 'dao' => 'CRM_Contact_DAO_Contact',
+ 'fields' => $this->getBasicContactFields(),
+ 'filters' => [
+ 'sort_name' => [
+ 'title' => ts('Contact Name'),
+ 'operator' => 'like',
+ ],
+ 'is_deleted' => [
+ 'title' => ts('Is Deleted'),
+ 'default' => 0,
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ ],
+ 'id' => ['no_display' => TRUE],
+ ],
+ 'order_bys' => [
+ 'sort_name' => [
+ 'title' => ts('Last Name, First Name'),
+ 'default' => '1',
+ 'default_weight' => '0',
+ 'default_order' => 'ASC',
+ ],
+ ],
+ 'grouping' => 'contact-fields',
+ ],
+ 'civicrm_membership' => [
+ 'dao' => 'CRM_Member_DAO_Membership',
+ 'fields' => [
+ 'membership_type_id' => [
+ 'title' => ts('Membership Type'),
+ 'required' => TRUE,
+ 'no_repeat' => TRUE,
+ ],
+ 'membership_start_date' => [
+ 'title' => ts('Start Date'),
+ 'default' => TRUE,
+ ],
+ 'membership_end_date' => [
+ 'title' => ts('End Date'),
+ 'default' => TRUE,
+ ],
+ 'owner_membership_id' => [
+ 'title' => ts('Primary/Inherited?'),
+ 'default' => TRUE,
+ ],
+ 'join_date' => [
+ 'title' => ts('Join Date'),
+ 'default' => TRUE,
+ ],
+ 'source' => ['title' => ts('Source')],
+ 'is_auto_renew' => [
+ 'title' => ts('Auto Renew?'),
+ 'default' => 0,
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ 'dbAlias' => 'IF(ISNULL(membership_civireport.contribution_recur_id), 0, 1)',
+ ],
+ 'group_id' => [
+ 'dbAlias' => 'group_temp_table.group_id',
+ 'title' => ts('Group(s)'),
+ ],
+ ],
+ 'filters' => [
+ 'membership_join_date' => ['operatorType' => CRM_Report_Form::OP_DATE],
+ 'membership_start_date' => ['operatorType' => CRM_Report_Form::OP_DATE],
+ 'membership_end_date' => ['operatorType' => CRM_Report_Form::OP_DATE],
+ 'is_auto_renew' => [
+ 'title' => ts('Auto Renew?'),
+ 'type' => CRM_Utils_Type::T_BOOLEAN,
+ 'dbAlias' => 'membership_civireport.contribution_recur_id',
+ ],
+ 'owner_membership_id' => [
+ 'title' => ts('Primary Membership'),
+ 'operatorType' => CRM_Report_Form::OP_INT,
+ ],
+ 'tid' => [
+ 'name' => 'membership_type_id',
+ 'title' => ts('Membership Types'),
+ 'type' => CRM_Utils_Type::T_INT,
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Member_PseudoConstant::membershipType(),
+ ],
+ 'group_id' => [
+ 'name' => 'group_id',
+ 'title' => ts('Group(s)'),
+ 'type' => CRM_Utils_Type::T_INT,
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Core_PseudoConstant::nestedGroup(),
+ ],
+ ],
+ 'order_bys' => [
+ 'membership_type_id' => [
+ 'title' => ts('Membership Type'),
+ 'default' => '0',
+ 'default_weight' => '1',
+ 'default_order' => 'ASC',
+ ],
+ ],
+ 'grouping' => 'member-fields',
+ 'group_bys' => [
+ 'id' => [
+ 'title' => ts('Membership'),
+ 'default' => TRUE,
+ ],
+ ],
+ ],
+ 'civicrm_membership_status' => [
+ 'dao' => 'CRM_Member_DAO_MembershipStatus',
+ 'alias' => 'mem_status',
+ 'fields' => [
+ 'name' => [
+ 'title' => ts('Status'),
+ 'default' => TRUE,
+ ],
+ ],
+ 'filters' => [
+ 'sid' => [
+ 'name' => 'id',
+ 'title' => ts('Status'),
+ 'type' => CRM_Utils_Type::T_INT,
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'label'),
+ ],
+ ],
+ 'grouping' => 'member-fields',
+ ],
+ 'civicrm_email' => [
+ 'dao' => 'CRM_Core_DAO_Email',
+ 'fields' => ['email' => NULL],
+ 'grouping' => 'contact-fields',
+ ],
+ 'civicrm_phone' => [
+ 'dao' => 'CRM_Core_DAO_Phone',
+ 'fields' => ['phone' => NULL],
+ 'grouping' => 'contact-fields',
+ ],
+ 'civicrm_contribution' => [
+ 'dao' => 'CRM_Contribute_DAO_Contribution',
+ 'fields' => [
+ 'contribution_id' => [
+ 'name' => 'id',
+ 'no_display' => TRUE,
+ 'required' => TRUE,
+ ],
+ 'financial_type_id' => ['title' => ts('Financial Type')],
+ 'contribution_status_id' => ['title' => ts('Contribution Status')],
+ 'payment_instrument_id' => ['title' => ts('Payment Type')],
+ 'currency' => [
+ 'required' => TRUE,
+ 'no_display' => TRUE,
+ ],
+ 'trxn_id' => NULL,
+ 'receive_date' => NULL,
+ 'receipt_date' => NULL,
+ 'fee_amount' => NULL,
+ 'net_amount' => NULL,
+ 'total_amount' => [
+ 'title' => ts('Payment Amount (most recent)'),
+ 'statistics' => ['sum' => ts('Amount')],
+ ],
+ ],
+ 'filters' => [
+ 'receive_date' => ['operatorType' => CRM_Report_Form::OP_DATE],
+ 'financial_type_id' => [
+ 'title' => ts('Financial Type'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Contribute_PseudoConstant::financialType(),
+ 'type' => CRM_Utils_Type::T_INT,
+ ],
+ 'payment_instrument_id' => [
+ 'title' => ts('Payment Type'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Contribute_PseudoConstant::paymentInstrument(),
+ 'type' => CRM_Utils_Type::T_INT,
+ ],
+ 'currency' => [
+ 'title' => ts('Currency'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Core_OptionGroup::values('currencies_enabled'),
+ 'default' => NULL,
+ 'type' => CRM_Utils_Type::T_STRING,
+ ],
+ 'contribution_status_id' => [
+ 'title' => ts('Contribution Status'),
+ 'operatorType' => CRM_Report_Form::OP_MULTISELECT,
+ 'options' => CRM_Contribute_BAO_Contribution::buildOptions('contribution_status_id', 'search'),
+ 'type' => CRM_Utils_Type::T_INT,
+ ],
+ 'total_amount' => ['title' => ts('Contribution Amount')],
+ ],
+ 'order_bys' => [
+ 'receive_date' => [
+ 'title' => ts('Date Received'),
+ 'default_weight' => '2',
+ 'default_order' => 'DESC',
+ ],
+ ],
+ 'grouping' => 'contri-fields',
+ ],
+ ] + $this->getAddressColumns([
+ // These options are only excluded because they were not previously present.
+ 'order_by' => FALSE,
+ 'group_by' => FALSE,
+ ]);
+ $this->_groupFilter = TRUE;
+ $this->_tagFilter = TRUE;
+
+ // If we have campaigns enabled, add those elements to both the fields, filters and sorting
+ $this->addCampaignFields('civicrm_membership', FALSE, TRUE);
+
+ $this->_currencyColumn = 'civicrm_contribution_currency';
+ parent::__construct();
+ }
+
+ public function preProcess() {
+ $this->assign('reportTitle', ts('Membership Detail Report'));
+ parent::preProcess();
+ }
+
+ public function from() {
+ $groupTable = $this->buildGroupTempTable();
+ $filteredGroups = (array) $this->_params['group_id_value'];
+ $side = empty($filteredGroups) ? 'LEFT' : 'INNER';
+ $this->setFromBase('civicrm_contact');
+ $this->_from .= "
+ {$this->_aclFrom}
+ INNER JOIN civicrm_membership {$this->_aliases['civicrm_membership']}
+ ON {$this->_aliases['civicrm_contact']}.id =
+ {$this->_aliases['civicrm_membership']}.contact_id AND {$this->_aliases['civicrm_membership']}.is_test = 0
+ LEFT JOIN civicrm_membership_status {$this->_aliases['civicrm_membership_status']}
+ ON {$this->_aliases['civicrm_membership_status']}.id =
+ {$this->_aliases['civicrm_membership']}.status_id
+ $side JOIN {$groupTable} group_temp_table ON {$this->_aliases['civicrm_contact']}.id = group_temp_table.contact_id
+ ";
+
+ $this->joinAddressFromContact();
+ $this->joinPhoneFromContact();
+ $this->joinEmailFromContact();
+
+ //used when contribution field is selected.
+ if ($this->isTableSelected('civicrm_contribution')) {
+ $this->_from .= "
+ LEFT JOIN civicrm_membership_payment cmp
+ ON {$this->_aliases['civicrm_membership']}.id = cmp.membership_id
+ LEFT JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
+ ON cmp.contribution_id={$this->_aliases['civicrm_contribution']}.id\n";
+ }
+ }
+
+ public function getOperationPair($type = "string", $fieldName = NULL) {
+ //re-name IS NULL/IS NOT NULL for clarity
+ if ($fieldName == 'owner_membership_id') {
+ $result = [];
+ $result['nll'] = ts('Primary members only');
+ $result['nnll'] = ts('Non-primary members only');
+ $options = parent::getOperationPair($type, $fieldName);
+ foreach ($options as $key => $label) {
+ if (!array_key_exists($key, $result)) {
+ $result[$key] = $label;
+ }
+ }
+ }
+ else {
+ $result = parent::getOperationPair($type, $fieldName);
+ }
+ return $result;
+ }
+
+ function where() {
+ $clauses = array();
+ foreach ($this->_columns as $tableName => $table) {
+ if (array_key_exists('filters', $table)) {
+ foreach ($table['filters'] as $fieldName => $field) {
+ if ($field['name'] == 'group_id') {
+ continue;
+ }
+ $clause = NULL;
+ if (CRM_Utils_Array::value('operatorType', $field) & CRM_Utils_Type::T_DATE) {
+ $relative = CRM_Utils_Array::value("{$fieldName}_relative", $this->_params);
+ $from = CRM_Utils_Array::value("{$fieldName}_from", $this->_params);
+ $to = CRM_Utils_Array::value("{$fieldName}_to", $this->_params);
+
+ $this->_dateClause = $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
+ }
+ elseif ($field['name'] == 'is_auto_renew') {
+ if ($this->_params['is_auto_renew_value'] !== NULL) {
+ $clause = $this->_params['is_auto_renew_value'] == 1 ? "{$this->_aliases['civicrm_membership']}.contribution_recur_id IS NOT NULL" : "{$this->_aliases['civicrm_membership']}.contribution_recur_id IS NULL";
+ }
+ }
+ else {
+ $op = CRM_Utils_Array::value("{$fieldName}_op", $this->_params);
+ if ($op) {
+ $clause = $this->whereClause($field,
+ $op,
+ CRM_Utils_Array::value("{$fieldName}_value", $this->_params),
+ CRM_Utils_Array::value("{$fieldName}_min", $this->_params),
+ CRM_Utils_Array::value("{$fieldName}_max", $this->_params)
+ );
+ }
+ }
+
+ if (!empty($clause)) {
+ $clauses[] = $clause;
+ }
+ }
+ }
+ }
+
+ if (empty($clauses)) {
+ $this->_where = "WHERE ( 1 ) ";
+ }
+ else {
+ $this->_where = "WHERE " . implode(' AND ', $clauses);
+ }
+ }
+
+ /**
+ * Alter display of rows.
+ *
+ * Iterate through the rows retrieved via SQL and make changes for display purposes,
+ * such as rendering contacts as links.
+ *
+ * @param array $rows
+ * Rows generated by SQL, with an array for each row.
+ */
+ public function alterDisplay(&$rows) {
+ $entryFound = FALSE;
+ $checkList = [];
+
+ $contributionTypes = CRM_Contribute_PseudoConstant::financialType();
+ $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'label');
+ $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument();
+
+ $repeatFound = FALSE;
+ foreach ($rows as $rowNum => $row) {
+ if ($repeatFound == FALSE ||
+ $repeatFound < $rowNum - 1
+ ) {
+ unset($checkList);
+ $checkList = [];
+ }
+ if (!empty($this->_noRepeats) && $this->_outputMode != 'csv') {
+ // not repeat contact display names if it matches with the one
+ // in previous row
+ foreach ($row as $colName => $colVal) {
+ if (in_array($colName, $this->_noRepeats) &&
+ $rowNum > 0
+ ) {
+ if ($rows[$rowNum][$colName] == $rows[$rowNum - 1][$colName] ||
+ (!empty($checkList[$colName]) &&
+ in_array($colVal, $checkList[$colName]))
+ ) {
+ $rows[$rowNum][$colName] = "";
+ // CRM-15917: Don't blank the name if it's a different contact
+ if ($colName == 'civicrm_contact_exposed_id') {
+ $rows[$rowNum]['civicrm_contact_sort_name'] = "";
+ }
+ $repeatFound = $rowNum;
+ }
+ }
+ if (in_array($colName, $this->_noRepeats)) {
+ $checkList[$colName][] = $colVal;
+ }
+ }
+ }
+
+ if (array_key_exists('civicrm_membership_membership_type_id', $row)) {
+ if ($value = $row['civicrm_membership_membership_type_id']) {
+ $rows[$rowNum]['civicrm_membership_membership_type_id'] = CRM_Member_PseudoConstant::membershipType($value, FALSE);
+ }
+ $entryFound = TRUE;
+ }
+
+ if (array_key_exists('civicrm_contact_sort_name', $row) &&
+ $rows[$rowNum]['civicrm_contact_sort_name'] &&
+ array_key_exists('civicrm_contact_id', $row)
+ ) {
+ $url = CRM_Utils_System::url("civicrm/contact/view",
+ 'reset=1&cid=' . $row['civicrm_contact_id'],
+ $this->_absoluteUrl
+ );
+ $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
+ $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts("View Contact Summary for this Contact.");
+ $entryFound = TRUE;
+ }
+
+ if ($value = CRM_Utils_Array::value('civicrm_contribution_financial_type_id', $row)) {
+ $rows[$rowNum]['civicrm_contribution_financial_type_id'] = $contributionTypes[$value];
+ $entryFound = TRUE;
+ }
+ if ($value = CRM_Utils_Array::value('civicrm_contribution_contribution_status_id', $row)) {
+ $rows[$rowNum]['civicrm_contribution_contribution_status_id'] = $contributionStatus[$value];
+ $entryFound = TRUE;
+ }
+ if ($value = CRM_Utils_Array::value('civicrm_contribution_payment_instrument_id', $row)) {
+ $rows[$rowNum]['civicrm_contribution_payment_instrument_id'] = $paymentInstruments[$value];
+ $entryFound = TRUE;
+ }
+
+ if (array_key_exists('civicrm_membership_owner_membership_id', $row)) {
+ $value = $row['civicrm_membership_owner_membership_id'];
+ $rows[$rowNum]['civicrm_membership_owner_membership_id'] = ($value != '') ? 'Inherited' : 'Primary';
+ $entryFound = TRUE;
+ }
+
+ // Convert campaign_id to campaign title
+ if (array_key_exists('civicrm_membership_campaign_id', $row)) {
+ if ($value = $row['civicrm_membership_campaign_id']) {
+ $rows[$rowNum]['civicrm_membership_campaign_id'] = $this->campaigns[$value];
+ $entryFound = TRUE;
+ }
+ }
+ $entryFound = $this->alterDisplayAddressFields($row, $rows, $rowNum, 'member/detail', 'List all memberships(s) for this ') ? TRUE : $entryFound;
+ $entryFound = $this->alterDisplayContactFields($row, $rows, $rowNum, 'member/detail', 'List all memberships(s) for this ') ? TRUE : $entryFound;
+
+ if (!$entryFound) {
+ break;
+ }
+ }
+ }
+
+ /**
+ * Create a table of the contact ids included by the group filter.
+ *
+ * This function is called by both the api (tests) and the UI.
+ */
+ public function buildGroupTempTable() {
+ $filteredGroups = (array) $this->_params['group_id_value'];
+ $op = $this->_params['group_id_op'];
+
+
+ if (empty($filteredGroups) || in_array($op, ['nll', 'nnll'])) {
+ $where = ($op == 'nll') ? 'group_contact.group_id IS NOT NULL' : ($op = 'nnll') ? ' group_contact.group_id IS NULL ' : '(1)';
+ }
+ else {
+ $op = ($op == 'in') ? 'IN' : 'NOT IN';
+ $where = sprintf(' group_contact.group_id %s (%s)', $op, implode(', ', $filteredGroups));
+ }
+
+ $query = "
+ SELECT DISTINCT group_contact.contact_id, GROUP_CONCAT(DISTINCT g.title) as group_id
+ FROM civicrm_group_contact group_contact
+ INNER JOIN civicrm_group g ON g.id = group_contact.group_id
+ WHERE {$where}
+ AND group_contact.status = 'Added'
+ GROUP BY group_contact.contact_id
+ ";
+
+ $where = str_replace('group_contact', 'smartgroup_contact', $where);
+ $query .= "
+ UNION DISTINCT
+ SELECT smartgroup_contact.contact_id, GROUP_CONCAT(DISTINCT g.title) as group_id
+ FROM civicrm_group_contact_cache smartgroup_contact
+ INNER JOIN civicrm_group g ON g.id = smartgroup_contact.group_id
+ WHERE {$where}
+ GROUP BY smartgroup_contact.contact_id
+ ";
+
+ $groupTempTable = $this->createTemporaryTable('rptgrp', $query);
+ CRM_Core_DAO::executeQuery("ALTER TABLE $groupTempTable ADD INDEX i_id(contact_id)");
+ return $groupTempTable;
+ }
+
+}
--
GitLab