(WIP) PCHR-3499: Reports Migration Milestone 2

[tunbola]

Overview

Sequel to #107, A couple more changes have been made to the Pivot Report Extension. This includes:

• Abstracting the way Report Entities return data: Report Entities like People, Leave can now return data via the getData method without needing to name the Report classes after the main API entity that is needed to fetch the reports data. All other existing report entities were also modified to return data via the getData method. This introduces flexibility on the naming convention for the classes and the People report classes were renamed from having Contact to People e.g CRM_PivotData_DataContact was renamed to CRM_PivotData_DataPeople while People is now the report entity rather than the API entity it must represent before the change.
• Flexibility in Report titles: Before the new changes, the Report titles displayed on the respective reports page must follow this format

  $ApIentityName . ' Pivot Report'

A new method getTitle was introduced in the Group Entity report class that allows each report class to return the report title.

For the leave Report:

 public function getTitle($entityName) {
    return ts('Leave Reports');
  }

• Hookable Report Entities: Three main files are needed to display reports for an entity, A class to extend CRM_PivotData_AbstractData, a class to extend CRM_PivotCache_AbstractGroup and the report template file. I experimented with an implementation that allows these classes to reside in the extension providing the report. A new hook was introduced in the Pivot Report extension hrleaveandabsences_addPivotReportEntities which allows other extensions to add data to the supported entities array of the Pivot extension. For example the L&A extension can implement the hook like so:

  
  function hrleaveandabsences_addPivotReportEntities(&$reportEntities) {
  $reportEntities['Sample'] = [
  'hookable' => [
    'data_class' => 'CRM_HRLeaveAndAbsences_PivotData_DataSample',
    'group_class' => 'CRM_HRLeaveAndAbsences_PivotCache_GroupSample',
    'template_path' => 'CRM/HRLeaveAndAbsences/Page/SampleReport.tpl'
  ]
  ];
  }

This flexibility in the naming of the  Data and Group file allows the files to be named in any way the extension deems fit.
```php
     if (!empty($reportEntityData['hookable']['data_class'])) {
      $className = $reportEntityData['hookable']['data_class'];
    }

    if (!empty($reportEntityData['hookable']['group_class'])) {
     $className = $reportEntityData['hookable']['group_class'];
    }

The template file is included in this way:

    if ($hookableData) {
      if(!empty($hookableData['template_path'])) {
        $this->assign('templatePath', $hookableData['template_path']);
      }
    }

• Field Handlers: Field handlers was introduced that allows a field data to be manipulated before it is cached.

    if(isset($fields[$resultKey]['handler'])) {
      if(method_exists($this, $fields[$resultKey]['handler'])) {
        $value = call_user_func([$this, $fields[$resultKey]['handler']], $value, $data);
      }
    }
  
    $fields['Contact']['birth_date'] = [
      'name' => 'birth_date',
      'title' => ts('Employee age'),
      'handler' => 'birthDateHandler'
    ];

Leave Reports Migration

The Leave Reports was added to the Pivot Report extension. The getData method of the Leave report entity returns data via chained API calls. All the columns available in the original report were added. Field handlers present in the original report was also added to the Leave pivot report.

• Some improvements can still be done such as caching some API calls that are called more than once with same data.
• Some handlers added in the Leave report e.g the Birth date hander will be used by people reports so probably those common handlers would be moved to the parent Abstract Data class or maybe it might be better to make each handler a class on its own.

[tunbola]

@davialexandre, regarding making the date filter work for People reports based on the contract dates, after investigation on the Pivot JS library, it does not seem to have in-built functionality for this kind of filtering. I decided to pass this task over to a FE dev perhaps they will be able to come up with something that'll do what we need. Here's the ticket: https://compucorp.atlassian.net/browse/PCHR-3504

[tunbola]

Not needed anymore.