3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
35 class CRM_Report_Form_Contribute_Bookkeeping
extends CRM_Report_Form
{
36 protected $_addressField = FALSE;
38 protected $_emailField = FALSE;
40 protected $_summary = NULL;
42 protected $_customGroupExtends = array(
51 public function __construct() {
52 $this->_autoIncludeIndexedFieldsAsOrderBys
= 1;
53 $this->_columns
= array(
54 'civicrm_contact' => array(
55 'dao' => 'CRM_Contact_DAO_Contact',
58 'title' => ts('Contact Name'),
62 'first_name' => array(
63 'title' => ts('First Name'),
65 'middle_name' => array(
66 'title' => ts('Middle Name'),
69 'title' => ts('Last Name'),
76 'title' => ts('Gender'),
78 'birth_date' => array(
79 'title' => ts('Birth Date'),
83 'dbAlias' => 'TIMESTAMPDIFF(YEAR, contact_civireport.birth_date, CURDATE())',
85 'contact_type' => array(
86 'title' => ts('Contact Type'),
88 'contact_sub_type' => array(
89 'title' => ts('Contact Subtype'),
92 'grouping' => 'contact-fields',
95 'title' => ts('Last Name, First Name'),
97 'default_weight' => '0',
98 'default_order' => 'ASC',
100 'first_name' => array(
101 'name' => 'first_name',
102 'title' => ts('First Name'),
104 'gender_id' => array(
105 'name' => 'gender_id',
106 'title' => ts('Gender'),
108 'birth_date' => array(
109 'name' => 'birth_date',
110 'title' => ts('Birth Date'),
112 'contact_type' => array(
113 'title' => ts('Contact Type'),
115 'contact_sub_type' => array(
116 'title' => ts('Contact Subtype'),
120 'sort_name' => array(
121 'title' => ts('Contact Name'),
122 'operator' => 'like',
125 'title' => ts('Contact ID'),
126 'no_display' => TRUE,
128 'gender_id' => array(
129 'title' => ts('Gender'),
130 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
131 'options' => CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id'),
133 'birth_date' => array(
134 'title' => ts('Birth Date'),
135 'operatorType' => CRM_Report_Form
::OP_DATE
,
137 'contact_type' => array(
138 'title' => ts('Contact Type'),
140 'contact_sub_type' => array(
141 'title' => ts('Contact Subtype'),
145 'civicrm_membership' => array(
146 'dao' => 'CRM_Member_DAO_Membership',
149 'title' => ts('Membership #'),
150 'no_display' => TRUE,
155 'civicrm_financial_account' => array(
156 'dao' => 'CRM_Financial_DAO_FinancialAccount',
158 'debit_accounting_code' => array(
159 'title' => ts('Financial Account Code - Debit'),
160 'name' => 'accounting_code',
161 'alias' => 'financial_account_civireport_debit',
164 'credit_accounting_code' => array(
165 'title' => ts('Financial Account Code - Credit'),
166 'name' => 'accounting_code',
167 'alias' => 'financial_account_civireport_credit',
170 'debit_name' => array(
171 'title' => ts('Financial Account Name - Debit'),
173 'alias' => 'financial_account_civireport_debit',
176 'credit_name' => array(
177 'title' => ts('Financial Account Name - Credit'),
179 'alias' => 'financial_account_civireport_credit',
184 'debit_accounting_code' => array(
185 'title' => ts('Financial Account Code - Debit'),
186 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
187 'options' => CRM_Contribute_PseudoConstant
::financialAccount(NULL, NULL, 'accounting_code', 'accounting_code'),
188 'name' => 'accounting_code',
189 'alias' => 'financial_account_civireport_debit',
191 'credit_accounting_code' => array(
192 'title' => ts('Financial Account Code - Credit'),
193 'type' => CRM_Utils_Type
::T_INT
,
194 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
195 'options' => CRM_Contribute_PseudoConstant
::financialAccount(NULL, NULL, 'accounting_code', 'accounting_code'),
197 'debit_name' => array(
198 'title' => ts('Financial Account Name - Debit'),
199 'type' => CRM_Utils_Type
::T_STRING
,
200 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
201 'options' => CRM_Contribute_PseudoConstant
::financialAccount(),
203 'alias' => 'financial_account_civireport_debit',
205 'credit_name' => array(
206 'title' => ts('Financial Account Name - Credit'),
207 'type' => CRM_Utils_Type
::T_STRING
,
208 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
209 'options' => CRM_Contribute_PseudoConstant
::financialAccount(),
213 'civicrm_line_item' => array(
214 'dao' => 'CRM_Price_DAO_LineItem',
216 'financial_type_id' => array(
217 'title' => ts('Financial Type'),
222 'financial_type_id' => array(
223 'title' => ts('Financial Type'),
224 'type' => CRM_Utils_Type
::T_INT
,
225 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
226 'options' => CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes(),
229 'order_bys' => array(
230 'financial_type_id' => array('title' => ts('Financial Type')),
233 'civicrm_contribution' => array(
234 'dao' => 'CRM_Contribute_DAO_Contribution',
236 'receive_date' => array(
239 'invoice_id' => array(
240 'title' => ts('Invoice ID'),
243 'contribution_status_id' => array(
244 'title' => ts('Contribution Status'),
248 'title' => ts('Contribution #'),
253 'receive_date' => array('operatorType' => CRM_Report_Form
::OP_DATE
),
254 'contribution_status_id' => array(
255 'title' => ts('Contribution Status'),
256 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
257 'options' => CRM_Contribute_PseudoConstant
::contributionStatus(),
258 'default' => array(1),
261 'order_bys' => array(
262 'contribution_id' => array('title' => ts('Contribution #')),
263 'contribution_status_id' => array('title' => ts('Contribution Status')),
265 'grouping' => 'contri-fields',
267 'civicrm_financial_trxn' => array(
268 'dao' => 'CRM_Financial_DAO_FinancialTrxn',
270 'check_number' => array(
271 'title' => ts('Cheque #'),
274 'payment_instrument_id' => array(
275 'title' => ts('Payment Method'),
280 'no_display' => TRUE,
282 'trxn_date' => array(
283 'title' => ts('Transaction Date'),
285 'type' => CRM_Utils_Type
::T_DATE
,
288 'title' => ts('Trans #'),
293 'payment_instrument_id' => array(
294 'title' => ts('Payment Method'),
295 'type' => CRM_Utils_Type
::T_INT
,
296 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
297 'options' => CRM_Contribute_PseudoConstant
::paymentInstrument(),
300 'title' => 'Currency',
301 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
302 'options' => CRM_Core_OptionGroup
::values('currencies_enabled'),
304 'type' => CRM_Utils_Type
::T_STRING
,
306 'trxn_date' => array(
307 'title' => ts('Transaction Date'),
308 'operatorType' => CRM_Report_Form
::OP_DATE
,
309 'type' => CRM_Utils_Type
::T_DATE
,
312 'order_bys' => array(
313 'payment_instrument_id' => array('title' => ts('Payment Method')),
316 'civicrm_entity_financial_trxn' => array(
317 'dao' => 'CRM_Financial_DAO_EntityFinancialTrxn',
320 'title' => ts('Amount'),
322 'type' => CRM_Utils_Type
::T_STRING
,
326 'amount' => array('title' => ts('Amount')),
331 $this->_groupFilter
= TRUE;
332 $this->_tagFilter
= TRUE;
333 parent
::__construct();
336 public function preProcess() {
337 parent
::preProcess();
340 public function select() {
343 $this->_columnHeaders
= array();
344 foreach ($this->_columns
as $tableName => $table) {
345 if (array_key_exists('fields', $table)) {
346 foreach ($table['fields'] as $fieldName => $field) {
347 if (!empty($field['required']) ||
348 !empty($this->_params
['fields'][$fieldName])
350 switch ($fieldName) {
351 case 'credit_accounting_code':
353 WHEN {$this->_aliases['civicrm_financial_trxn']}.from_financial_account_id IS NOT NULL
354 THEN {$this->_aliases['civicrm_financial_account']}_credit_1.accounting_code
355 ELSE {$this->_aliases['civicrm_financial_account']}_credit_2.accounting_code
356 END AS civicrm_financial_account_credit_accounting_code ";
361 WHEN {$this->_aliases['civicrm_entity_financial_trxn']}_item.entity_id IS NOT NULL
362 THEN {$this->_aliases['civicrm_entity_financial_trxn']}_item.amount
363 ELSE {$this->_aliases['civicrm_entity_financial_trxn']}.amount
364 END AS civicrm_entity_financial_trxn_amount ";
369 WHEN {$this->_aliases['civicrm_financial_trxn']}.from_financial_account_id IS NOT NULL
370 THEN {$this->_aliases['civicrm_financial_account']}_credit_1.name
371 ELSE {$this->_aliases['civicrm_financial_account']}_credit_2.name
372 END AS civicrm_financial_account_credit_name ";
376 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
379 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'];
380 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
386 $this->_select
= 'SELECT ' . implode(', ', $select) . ' ';
389 public function from() {
392 $this->_from
= "FROM civicrm_contact {$this->_aliases['civicrm_contact']} {$this->_aclFrom}
393 INNER JOIN civicrm_contribution {$this->_aliases['civicrm_contribution']}
394 ON {$this->_aliases['civicrm_contact']}.id = {$this->_aliases['civicrm_contribution']}.contact_id AND
395 {$this->_aliases['civicrm_contribution']}.is_test = 0
396 LEFT JOIN civicrm_membership_payment payment
397 ON ( {$this->_aliases['civicrm_contribution']}.id = payment.contribution_id )
398 LEFT JOIN civicrm_membership {$this->_aliases['civicrm_membership']}
399 ON payment.membership_id = {$this->_aliases['civicrm_membership']}.id
400 LEFT JOIN civicrm_entity_financial_trxn {$this->_aliases['civicrm_entity_financial_trxn']}
401 ON ({$this->_aliases['civicrm_contribution']}.id = {$this->_aliases['civicrm_entity_financial_trxn']}.entity_id AND
402 {$this->_aliases['civicrm_entity_financial_trxn']}.entity_table = 'civicrm_contribution')
403 LEFT JOIN civicrm_financial_trxn {$this->_aliases['civicrm_financial_trxn']}
404 ON {$this->_aliases['civicrm_financial_trxn']}.id = {$this->_aliases['civicrm_entity_financial_trxn']}.financial_trxn_id
405 LEFT JOIN civicrm_financial_account {$this->_aliases['civicrm_financial_account']}_debit
406 ON {$this->_aliases['civicrm_financial_trxn']}.to_financial_account_id = {$this->_aliases['civicrm_financial_account']}_debit.id
407 LEFT JOIN civicrm_financial_account {$this->_aliases['civicrm_financial_account']}_credit_1
408 ON {$this->_aliases['civicrm_financial_trxn']}.from_financial_account_id = {$this->_aliases['civicrm_financial_account']}_credit_1.id
409 LEFT JOIN civicrm_entity_financial_trxn {$this->_aliases['civicrm_entity_financial_trxn']}_item
410 ON ({$this->_aliases['civicrm_financial_trxn']}.id = {$this->_aliases['civicrm_entity_financial_trxn']}_item.financial_trxn_id AND
411 {$this->_aliases['civicrm_entity_financial_trxn']}_item.entity_table = 'civicrm_financial_item')
412 LEFT JOIN civicrm_financial_item fitem
413 ON fitem.id = {$this->_aliases['civicrm_entity_financial_trxn']}_item.entity_id
414 LEFT JOIN civicrm_financial_account {$this->_aliases['civicrm_financial_account']}_credit_2
415 ON fitem.financial_account_id = {$this->_aliases['civicrm_financial_account']}_credit_2.id
416 LEFT JOIN civicrm_line_item {$this->_aliases['civicrm_line_item']}
417 ON fitem.entity_id = {$this->_aliases['civicrm_line_item']}.id AND fitem.entity_table = 'civicrm_line_item' ";
418 $this->getPermissionedFTQuery($this, "civicrm_line_item_1");
421 public function orderBy() {
424 // please note this will just add the order-by columns to select query, and not display in column-headers.
425 // This is a solution to not throw fatal errors when there is a column in order-by, not present in select/display columns.
426 foreach ($this->_orderByFields
as $orderBy) {
427 if (!array_key_exists($orderBy['name'], $this->_params
['fields']) &&
428 empty($orderBy['section'])
430 $this->_select
.= ", {$orderBy['dbAlias']} as {$orderBy['tplField']}";
435 public function where() {
436 foreach ($this->_columns
as $tableName => $table) {
437 if (array_key_exists('filters', $table)) {
438 foreach ($table['filters'] as $fieldName => $field) {
440 if ($fieldName == 'credit_accounting_code') {
441 $field['dbAlias'] = "CASE
442 WHEN financial_trxn_civireport.from_financial_account_id IS NOT NULL
443 THEN financial_account_civireport_credit_1.accounting_code
444 ELSE financial_account_civireport_credit_2.accounting_code
447 elseif ($fieldName == 'credit_name') {
448 $field['dbAlias'] = "CASE
449 WHEN financial_trxn_civireport.from_financial_account_id IS NOT NULL
450 THEN financial_account_civireport_credit_1.id
451 ELSE financial_account_civireport_credit_2.id
454 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
455 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
456 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
457 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
459 $clause = $this->dateClause($field['name'], $relative, $from, $to, $field['type']);
462 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
464 $clause = $this->whereClause($field,
466 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
467 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
468 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
472 if (!empty($clause)) {
473 $clauses[] = $clause;
478 if (empty($clauses)) {
479 $this->_where
= 'WHERE ( 1 )';
482 $this->_where
= 'WHERE ' . implode(' AND ', $clauses);
486 public function postProcess() {
487 // get the acl clauses built before we assemble the query
488 $this->buildACLClause($this->_aliases
['civicrm_contact']);
489 parent
::postProcess();
492 public function groupBy() {
493 $this->_groupBy
= " GROUP BY {$this->_aliases['civicrm_entity_financial_trxn']}.id, {$this->_aliases['civicrm_line_item']}.id ";
501 public function statistics(&$rows) {
502 $statistics = parent
::statistics($rows);
503 $tempTableName = CRM_Core_DAO
::createTempTableName('civicrm_contribution');
504 $select = "SELECT {$this->_aliases['civicrm_contribution']}.id, {$this->_aliases['civicrm_entity_financial_trxn']}.id as trxnID, {$this->_aliases['civicrm_contribution']}.currency,
506 WHEN {$this->_aliases['civicrm_entity_financial_trxn']}_item.entity_id IS NOT NULL
507 THEN {$this->_aliases['civicrm_entity_financial_trxn']}_item.amount
508 ELSE {$this->_aliases['civicrm_entity_financial_trxn']}.amount
512 $tempQuery = "CREATE TEMPORARY TABLE {$tempTableName} CHARACTER SET utf8 COLLATE utf8_unicode_ci AS
513 {$select} {$this->_from} {$this->_where} {$this->_groupBy} ";
514 CRM_Core_DAO
::executeQuery($tempQuery);
516 $sql = "SELECT COUNT(trxnID) as count, SUM(amount) as amount, currency
517 FROM {$tempTableName}
519 $dao = CRM_Core_DAO
::executeQuery($sql);
520 $amount = $avg = array();
521 while ($dao->fetch()) {
522 $amount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
);
523 $avg[] = CRM_Utils_Money
::format(round(($dao->amount
/
524 $dao->count
), 2), $dao->currency
);
527 $statistics['counts']['amount'] = array(
528 'value' => implode(', ', $amount),
529 'title' => 'Total Amount',
530 'type' => CRM_Utils_Type
::T_STRING
,
532 $statistics['counts']['avg'] = array(
533 'value' => implode(', ', $avg),
534 'title' => 'Average',
535 'type' => CRM_Utils_Type
::T_STRING
,
541 * Alter display of rows.
543 * Iterate through the rows retrieved via SQL and make changes for display purposes,
544 * such as rendering contacts as links.
547 * Rows generated by SQL, with an array for each row.
549 public function alterDisplay(&$rows) {
550 $contributionTypes = CRM_Contribute_PseudoConstant
::financialType();
551 $paymentInstruments = CRM_Contribute_PseudoConstant
::paymentInstrument();
552 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
553 foreach ($rows as $rowNum => $row) {
554 // convert display name to links
555 if (array_key_exists('civicrm_contact_sort_name', $row) &&
556 !empty($rows[$rowNum]['civicrm_contact_sort_name']) &&
557 array_key_exists('civicrm_contact_id', $row)
559 $url = CRM_Utils_System
::url('civicrm/contact/view',
560 'reset=1&cid=' . $row['civicrm_contact_id'],
563 $rows[$rowNum]['civicrm_contact_sort_name_link'] = $url;
564 $rows[$rowNum]['civicrm_contact_sort_name_hover'] = ts('View Contact Summary for this Contact.');
567 // handle contribution status id
568 if ($value = CRM_Utils_Array
::value('civicrm_contribution_contribution_status_id', $row)) {
569 $rows[$rowNum]['civicrm_contribution_contribution_status_id'] = $contributionStatus[$value];
572 // handle payment instrument id
573 if ($value = CRM_Utils_Array
::value('civicrm_financial_trxn_payment_instrument_id', $row)) {
574 $rows[$rowNum]['civicrm_financial_trxn_payment_instrument_id'] = $paymentInstruments[$value];
577 // handle financial type id
578 if ($value = CRM_Utils_Array
::value('civicrm_line_item_financial_type_id', $row)) {
579 $rows[$rowNum]['civicrm_line_item_financial_type_id'] = $contributionTypes[$value];
581 if ($value = CRM_Utils_Array
::value('civicrm_entity_financial_trxn_amount', $row)) {
582 $rows[$rowNum]['civicrm_entity_financial_trxn_amount'] = CRM_Utils_Money
::format($rows[$rowNum]['civicrm_entity_financial_trxn_amount'], $rows[$rowNum]['civicrm_financial_trxn_currency']);
586 if (array_key_exists('civicrm_contact_gender_id', $row)) {
587 if ($value = $row['civicrm_contact_gender_id']) {
588 $gender = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id');
589 $rows[$rowNum]['civicrm_contact_gender_id'] = $gender[$value];
594 // display birthday in the configured custom format
595 if (array_key_exists('civicrm_contact_birth_date', $row)) {
596 $birthDate = $row['civicrm_contact_birth_date'];
598 $rows[$rowNum]['civicrm_contact_birth_date'] = CRM_Utils_Date
::customFormat($birthDate, '%Y%m%d');