From: Pradeep Nayak Date: Tue, 5 Jul 2016 21:33:45 +0000 (+0530) Subject: [ready-for-core-team-review]CRM-16189, added Deferred Revenue report (#8656) X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=3c6d64527cd83da3643b231fda31c6c4e5392514;p=civicrm-core.git [ready-for-core-team-review]CRM-16189, added Deferred Revenue report (#8656) * CRM-16189, added Deferred Revenue report ---------------------------------------- * CRM-16189: Improve support for Accrual Method bookkeeping https://issues.civicrm.org/jira/browse/CRM-16189 * --CRM-16189, fixed jenkin errors * CRM-16189, added Install code ---------------------------------------- * CRM-16189: Improve support for Accrual Method bookkeeping https://issues.civicrm.org/jira/browse/CRM-16189 * CRM-16189, used financial trxn table to get other details ---------------------------------------- * CRM-16189: Improve support for Accrual Method bookkeeping https://issues.civicrm.org/jira/browse/CRM-16189 * CRM-16189, added transaction date ---------------------------------------- * CRM-16189: Improve support for Accrual Method bookkeeping https://issues.civicrm.org/jira/browse/CRM-16189 * CRM-16189 Fixed jenkins error ---------------------------------------- * CRM-16189: Improve support for Accrual Method bookkeeping https://issues.civicrm.org/jira/browse/CRM-16189 * CRm-16189 Removed whitespace at EOL --- diff --git a/CRM/Report/Form/Contribute/DeferredRevenue.php b/CRM/Report/Form/Contribute/DeferredRevenue.php new file mode 100644 index 0000000000..ad45f2ed24 --- /dev/null +++ b/CRM/Report/Form/Contribute/DeferredRevenue.php @@ -0,0 +1,261 @@ +_autoIncludeIndexedFieldsAsOrderBys = 1; + $this->_deferredFinancialAccount = CRM_Financial_BAO_FinancialAccount::getAllDeferredFinancialAccount(); + $this->_columns = array( + 'civicrm_financial_account' => array( + 'dao' => 'CRM_Financial_DAO_FinancialAccount', + 'alias' => 'financial_account_deferred', + 'filters' => array( + 'id' => array( + 'title' => ts('Deferred Financial Account'), + 'operatorType' => CRM_Report_Form::OP_MULTISELECT, + 'options' => $this->_deferredFinancialAccount, + 'type' => CRM_Utils_Type::T_INT, + ), + ), + ), + ); + parent::__construct(); + } + + public function preProcess() { + parent::preProcess(); + } + + public function select() { + // TODO: add column + $this->_select = ' SELECT +financial_account_deferred_civireport.name deferred_account, +financial_account_deferred_civireport.id deferred_account_id, +financial_account_deferred_civireport.accounting_code deferred_account_code, +financial_account_revenue.name revenue_account, +financial_account_revenue.id revenue_account_id, +financial_account_revenue.accounting_code revenue_account_code, +financial_item.status_id, +financial_item.id item_id, +financial_trxn_contribution_1.status_id, +financial_trxn_contribution_1.trxn_date transaction_date, +financial_trxn_contribution_1.total_amount, +contribution.id contribution_id, +contribution.contact_id, +contact.display_name, +contribution.source, +GROUP_CONCAT(financial_trxn.total_amount) trxn_amount, +GROUP_CONCAT(financial_trxn.trxn_date) trxn_date, +financial_item.description, +IFNULL(membership.start_date, event.start_date) start_date, +IFNULL(membership.end_date, event.end_date) end_date +'; + } + + public function from() { + $deferredRelationship = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Deferred Revenue Account is' ")); + $revenueRelationship = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' ")); + $this->_from = " FROM civicrm_financial_item financial_item +INNER JOIN civicrm_entity_financial_account entity_financial_account_deferred + ON financial_item.financial_account_id = entity_financial_account_deferred.financial_account_id AND entity_financial_account_deferred.entity_table = 'civicrm_financial_type' + AND entity_financial_account_deferred.account_relationship = {$deferredRelationship} +INNER JOIN civicrm_financial_account financial_account_deferred_civireport + ON entity_financial_account_deferred.financial_account_id = financial_account_deferred_civireport.id +INNER JOIN civicrm_entity_financial_account entity_financial_account_revenue + ON entity_financial_account_deferred.entity_id = entity_financial_account_revenue.entity_id + AND entity_financial_account_deferred.entity_table= entity_financial_account_revenue.entity_table +INNER JOIN civicrm_financial_account financial_account_revenue + ON entity_financial_account_revenue.financial_account_id = financial_account_revenue.id + AND {$revenueRelationship} = entity_financial_account_revenue.account_relationship +INNER JOIN civicrm_entity_financial_trxn entity_financial_trxn_item + ON entity_financial_trxn_item.entity_id = financial_item.id AND entity_financial_trxn_item.entity_table = 'civicrm_financial_item' +INNER JOIN civicrm_financial_trxn financial_trxn + ON financial_trxn.from_financial_account_id = financial_account_deferred_civireport.id AND financial_trxn.id = entity_financial_trxn_item.financial_trxn_id +INNER JOIN civicrm_entity_financial_trxn financial_trxn_contribution + ON financial_trxn_contribution.financial_trxn_id = financial_trxn.id AND financial_trxn_contribution.entity_table = 'civicrm_contribution' +INNER JOIN civicrm_entity_financial_trxn entity_financial_trxn_contribution ON entity_financial_trxn_contribution.entity_id = financial_item.id and entity_financial_trxn_contribution.entity_table = 'civicrm_financial_item' +INNER JOIN civicrm_financial_trxn financial_trxn_contribution_1 ON financial_trxn_contribution_1.id = entity_financial_trxn_contribution.financial_trxn_id AND (financial_trxn_contribution_1.from_financial_account_id NOT IN (" . implode(',', array_keys($this->_deferredFinancialAccount)) . ") OR financial_trxn_contribution_1.from_financial_account_id IS NULL) +INNER JOIN civicrm_contribution contribution + ON contribution.id = financial_trxn_contribution.entity_id +INNER JOIN civicrm_contact contact + ON contact.id = contribution.contact_id +INNER JOIN civicrm_line_item line_item + ON line_item.contribution_id = contribution.id +LEFT JOIN civicrm_membership membership + ON CASE + WHEN line_item.entity_table = 'civicrm_membership' + THEN line_item.entity_id = membership.id + ELSE membership.id = 0 + END +LEFT JOIN civicrm_participant participant + ON CASE + WHEN line_item.entity_table = 'civicrm_participant' + THEN line_item.entity_id = participant.id + ELSE participant.id = 0 + END +LEFT JOIN civicrm_event event ON participant.event_id = event.id +"; + } + + public function orderBy() { + parent::orderBy(); + } + + public function where() { + $clauses = array(); + foreach ($this->_columns as $tableName => $table) { + if (array_key_exists('filters', $table)) { + foreach ($table['filters'] as $fieldName => $field) { + $clause = NULL; + if (CRM_Utils_Array::value('type', $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); + + $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 ' . implode(' AND ', $clauses); + } + } + + public function postProcess() { + $this->_noFields = TRUE; + parent::postProcess(); + } + + public function groupBy() { + $this->_groupBy = "GROUP BY financial_account_deferred_civireport.id, financial_account_revenue.id, financial_item.id"; + } + + /** + * Build output rows. + * + * @param string $sql + * @param array $rows + */ + public function buildRows($sql, &$rows) { + $dao = CRM_Core_DAO::executeQuery($sql); + if (!is_array($rows)) { + $rows = array(); + } + $statuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); + $dateColumn = array(); + $columns = array( + 'Transaction' => 1, + 'Date of Transaction' => 1, + 'Amount' => 1, + 'Contribution ID' => 1, + 'Item' => 1, + 'Contact ID' => 1, + 'Contact Name' => 1, + 'Source' => 1, + 'Start Date' => 1, + 'End Date' => 1, + ); + $dateFormat = Civi::settings()->get('dateformatFinancialBatch'); + while ($dao->fetch()) { + $arraykey = $dao->deferred_account_id . '_' . $dao->revenue_account_id; + if (empty($rows[$arraykey])) { + $rows[$arraykey]['label'] = "Deferred Revenue Account: {$dao->deferred_account} ({$dao->deferred_account_code}), Revenue Account: {$dao->revenue_account} {$dao->revenue_account_code}"; + } + $rows[$arraykey]['rows'][$dao->item_id] = array( + 'Transaction' => $statuses[$dao->status_id], + 'Date of Transaction' => CRM_Utils_Date::customFormat($dao->transaction_date, $dateFormat), + 'Amount' => CRM_Utils_Money::format($dao->total_amount), + 'Contribution ID' => $dao->contribution_id, + 'Item' => $dao->description, + 'Contact ID' => $dao->contact_id, + 'Contact Name' => $dao->display_name, + 'Source' => $dao->source, + 'Start Date' => CRM_Utils_Date::customFormat($dao->start_date, $dateFormat), + 'End Date' => CRM_Utils_Date::customFormat($dao->end_date, $dateFormat), + ); + $trxnDate = explode(',', $dao->trxn_date); + $trxnAmount = explode(',', $dao->trxn_amount); + foreach ($trxnDate as $key => $date) { + $keyDate = date('M, Y', strtotime($date)); + $rows[$arraykey]['rows'][$dao->item_id][$keyDate] = CRM_Utils_Money::format($trxnAmount[$key]); + $dateColumn[date('Ymd', strtotime($date))] = 1; + } + } + ksort($dateColumn); + foreach ($dateColumn as $key => $ignore) { + $columns[date('M, Y', strtotime($key))] = 1; + } + $this->_columnHeaders = $columns; + } + /** + * @param $rows + * + */ + public function statistics(&$rows) {} + + /** + * 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) {} + +} diff --git a/CRM/Upgrade/Incremental/sql/4.7.10.mysql.tpl b/CRM/Upgrade/Incremental/sql/4.7.10.mysql.tpl index cef8e7b2d1..03bf2447e7 100644 --- a/CRM/Upgrade/Incremental/sql/4.7.10.mysql.tpl +++ b/CRM/Upgrade/Incremental/sql/4.7.10.mysql.tpl @@ -1 +1,8 @@ {* file to handle db changes in 4.7.10 during upgrade *} +SELECT @option_group_id_report := max(id) from civicrm_option_group where name = 'report_template'; +SELECT @contributeCompId := max(id) FROM civicrm_component where name = 'CiviContribute'; +SELECT @option_group_id_report_wt := MAX(weight) FROM civicrm_option_value WHERE option_group_id = @option_group_id_report; +INSERT INTO + civicrm_option_value (option_group_id, {localize field='label'}label{/localize}, value, name, grouping, filter, is_default, weight, {localize field='description'}description{/localize}, is_optgroup, is_reserved, is_active, component_id, visibility_id) +VALUES + (@option_group_id_report, {localize}'{ts escape="sql"}{/ts}'{/localize}, 'contribute/tiralBalance', 'CRM_Report_Form_Contribute_DeferredRevenue', NULL, 0, NULL, @option_group_id_report_wt+1, {localize}'{ts escape="sql"}Deferred Revenue Details Report{/ts}'{/localize}, 0, 0, 1, @contributeCompId, NULL); diff --git a/templates/CRM/Report/Form/Contribute/DeferredRevenue.tpl b/templates/CRM/Report/Form/Contribute/DeferredRevenue.tpl new file mode 100644 index 0000000000..d5a4cb8c9a --- /dev/null +++ b/templates/CRM/Report/Form/Contribute/DeferredRevenue.tpl @@ -0,0 +1,70 @@ +{* + +--------------------------------------------------------------------+ + | CiviCRM version 4.7 | + +--------------------------------------------------------------------+ + | Copyright CiviCRM LLC (c) 2004-2016 | + +--------------------------------------------------------------------+ + | 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 | + +--------------------------------------------------------------------+ +*} +{if $criteriaForm OR $instanceForm OR $instanceFormError} +
+ {include file="CRM/Report/Form/Fields.tpl"} +
+{/if} + +
+ {*include actions*} + {include file="CRM/Report/Form/Actions.tpl"} + + {*Statistics at the Top of the page*} + {include file="CRM/Report/Form/Statistics.tpl" top=true} + + + {foreach from=$rows item=row} + + + + + {foreach from=$columnHeaders item=ignore key=header} + + {/foreach} + + + {foreach from=$row.rows item=innerRow} + + {foreach from=$columnHeaders item=ignore key=header} + + {/foreach} + {/foreach} + +{/foreach} +
{$row.label}
{$header}
{$innerRow.$header}
+ +
+ {*Statistics at the bottom of the page*} + {include file="CRM/Report/Form/Statistics.tpl" bottom=true} + + {include file="CRM/Report/Form/ErrorMessage.tpl"} +
+{if $outputMode == 'print'} + +{/if} diff --git a/xml/templates/civicrm_data.tpl b/xml/templates/civicrm_data.tpl index 7eafdfaf58..0b63df5bb4 100644 --- a/xml/templates/civicrm_data.tpl +++ b/xml/templates/civicrm_data.tpl @@ -638,6 +638,7 @@ VALUES (@option_group_id_report, {localize}'{ts escape="sql"}Contribution and Membership Details{/ts}'{/localize}, 'member/contributionDetail', 'CRM_Report_Form_Member_ContributionDetail', NULL, 0, NULL, 48, {localize}'{ts escape="sql"}Contribution details for any type of contribution, plus associated membership information for contributions which are in payment for memberships.{/ts}'{/localize}, 0, 0, 1, @memberCompId, NULL), (@option_group_id_report, {localize}'{ts escape="sql"}Recurring Contributions Report{/ts}'{/localize}, 'contribute/recur', 'CRM_Report_Form_Contribute_Recur', NULL, 0, NULL, 49, {localize}'{ts escape="sql"}Provides information about the status of recurring contributions{/ts}'{/localize}, 0, 0, 1, @contributeCompId, NULL), (@option_group_id_report, {localize}'{ts escape="sql"}Recurring Contributions Summary{/ts}'{/localize}, 'contribute/recursummary', 'CRM_Report_Form_Contribute_RecurSummary', NULL, 0, NULL, 49, {localize}'{ts escape="sql"}Provides simple summary for each payment instrument for which there are recurring contributions (e.g. Credit Card, Standing Order, Direct Debit, etc.), showing within a given date range.{/ts}'{/localize}, 0, 0, 1, @contributeCompId, NULL), + (@option_group_id_report, {localize}'{ts escape="sql"}Deferred Revenue Details{/ts}'{/localize}, 'contribute/deferredrevenue', 'CRM_Report_Form_Contribute_DeferredRevenue', NULL, 0, NULL, 50, {localize}'{ts escape="sql"}Deferred Revenue Details Report{/ts}'{/localize}, 0, 0, 1, @contributeCompId, NULL), (@option_group_id_acs, '{ts escape="sql"}Scheduled{/ts}', 1, 'Scheduled', NULL, 0, 1, 1, NULL, 0, 1, 1, NULL, NULL), (@option_group_id_acs, '{ts escape="sql"}Completed{/ts}', 2, 'Completed', NULL, 0, NULL, 2, NULL, 0, 1, 1, NULL, NULL),