MAE-360: Add batch column and filter to constituent and contribution detail reports

[ahed-compucorp]

Overview

We need to show DD batch name in the following reports :

• Contact Detail Report.
• Contribute Detail Report.

For Contact Detail Report we added Instruction Batch column and field.
For Contribute Detail Report we added Payment Batch column.

Please note that civicrm_alterReportVar hook will be fired 3 times:

• manualdirectdebit_civicrm_alterReportVar('columns', $var, $reportForm)
• manualdirectdebit_civicrm_alterReportVar('sql', $var, $reportForm)
• manualdirectdebit_civicrm_alterReportVar('rows', $var, $reportForm)

And we have a corresponding method handler:

• updateColumns
• updateSql
• updateRows

Contact Detail Report Before

Filters tab

Contact Detail Report After

Filters tab

Contribute Detail Report Before

Contribute Detail Report After

Comments

I could only add payment batch column to contribute detail report using a hacky way and couldn't add a filter for that because of a bug in the core.

The civicrm_alterReportVar is not working for contribute detail report when the user select the new column or choose the new filter, and it will show an error message DB Error: no such field

Here at Detail.php#L956 our changes to the _form attribute are lost and the error will be fired here Detail.php#L576

Unknown column 'some_table.some_column' in 'where clause'

I've tried to overcome this issue by doing (so hacky) :

1. Update the columns ContributeDetailReport.php#L85 so it will show in the report columns section.
2. When the user select the column and submit the form we unset our new column ContributeDetailReport.php#L41
3. Instead of accessing $reportForm object we access the request directly ContributeDetailReport.php#L69
4. We use _columnHeaders attribute in the sql hook ContributeDetailReport.php#L102
5. Because of 2 the column will not appear in the columns section but the result will have the new column.

[omarabuhussein]

in this class and in CRM/ManualDirectDebit/Hook/Alter/ContributeDetailReport.php

can you change all the other methods to be private and just keep this as public

[omarabuhussein]

civicrm API will retreuve only 25 records by default, so you need to pass this :

$params = [
'type_id' => ['IN' => $batchTypeIds],
'options' => ['limit' => 0],
..etc
]

to remove this restriction

[omarabuhussein]

same here about 'options' => ['limit' => 0],