Changed Age field so aggeragation is working correctly.

CHANGELOG.md

 # Version 1.7.0 (not yet released)
 
-
+* Changed Age field so aggeragation is working correctly.
+* Changed Field Specification to allow more advanced mysql functions
 
 # Version 1.6.0
 

Civi/DataProcessor/DataSpecification/FieldSpecification.php

@@ -56,6 +56,19 @@ class FieldSpecification implements SqlFieldSpecification {
 
   /**
    * @param $function
+   *
+   * Examples
+   *   YEAR
+   *
+   *   which is translated in
+   *   YEAR(`table`.`field`) AS `alias`
+   *
+   * Or you can use %1 for the name of the table and %2 for the name of the field.
+   * Such as:
+   *   CASE WHEN YEAR(`%1`.`%2`) == 2020 THEN 1 ELSE 0 END
+   *
+   *   which is translated in
+   *   (CASE WHEN YEAR(`table`.`field`) == 2020 THEN 1 ELSE 0 END) as `alias`
    */
   public function setMySqlFunction($function) {
     $this->sqlValueFormatFunction = $function;
@@ -70,7 +83,11 @@ class FieldSpecification implements SqlFieldSpecification {
    */
   public function getSqlSelectStatement($table_alias) {
     if ($this->sqlValueFormatFunction) {
-      return "{$this->sqlValueFormatFunction} (`{$table_alias}`.`{$this->name}`) AS `{$this->alias}`";
+      if (stripos($this->sqlValueFormatFunction, '%1') >= 0 && stripos($this->sqlValueFormatFunction, '%2') >= 0) {
+        return "(".str_replace(['%1', '%2'], [$table_alias, $this->name], $this->sqlValueFormatFunction). ") AS `{$this->alias}`";
+      } else {
+        return "{$this->sqlValueFormatFunction} (`{$table_alias}`.`{$this->name}`) AS `{$this->alias}`";
+      }
     }
     return "`{$table_alias}`.`{$this->name}` AS `{$this->alias}`";
   }
@@ -99,7 +116,11 @@ class FieldSpecification implements SqlFieldSpecification {
    */
   public function getSqlGroupByStatement($table_alias) {
     if ($this->sqlValueFormatFunction) {
-      return "{$this->sqlValueFormatFunction} (`{$table_alias}`.`{$this->name}`)";
+      if (stripos($this->sqlValueFormatFunction, '%1') >= 0 && stripos($this->sqlValueFormatFunction, '%2') >= 0) {
+        return "(".str_replace(['%1', '%2'], [$table_alias, $this->name], $this->sqlValueFormatFunction). ")";
+      } else {
+        return "{$this->sqlValueFormatFunction} (`{$table_alias}`.`{$this->name}`)";
+      }
     }
     return "`{$table_alias}`.`{$this->name}`";
   }

Civi/DataProcessor/FieldOutputHandler/AgeFieldOutputHandler.php

@@ -29,7 +29,7 @@ class AgeFieldOutputHandler extends AbstractSimpleFieldOutputHandler implements
    */
   public function initialize($alias, $title, $configuration) {
     parent::initialize($alias, $title, $configuration);
-    $this->inputFieldSpec->setMySqlFunction('DATE');
+    $this->inputFieldSpec->setMySqlFunction('CASE WHEN DATE(CONCAT(YEAR(CURRENT_DATE()), \'-\', MONTH(`%1`.`%2`), \'-\', DAYOFMONTH(`%1`.`%2`))) BETWEEN DATE_FORMAT(CURRENT_DATE(), \'%Y-01-01\') AND CURRENT_DATE() THEN YEAR(CURRENT_DATE()) - YEAR(`%1`.`%2`) ELSE YEAR(CURRENT_DATE()) - YEAR(`%1`.`%2`) -1 END');
     $this->isAggregateField = isset($configuration['is_aggregate']) ? $configuration['is_aggregate'] : false;
     if ($this->isAggregateField) {
       $dataFlow = $this->dataSource->ensureField($this->getAggregateFieldSpec());
@@ -91,10 +91,21 @@ class AgeFieldOutputHandler extends AbstractSimpleFieldOutputHandler implements
    * @return \Civi\DataProcessor\FieldOutputHandler\FieldOutput
    */
   public function formatField($rawRecord, $formattedRecord) {
-    $output = new FieldOutput();
-    if ($rawRecord[$this->inputFieldSpec->alias]) {
-      $date = new \DateTime($rawRecord[$this->inputFieldSpec->alias]);
+    $value = $rawRecord[$this->inputFieldSpec->alias];
+    $output = new FieldOutput($value);
+    // Check whether the value is a number.
+    // When it is a number the age has been calculated in the database.
+    // If not we have to calculate the age.
+    if ($value !== null && is_numeric($value) && strlen($value) != 10) {
+      // We check for strlen as civicrm format is yyyymmdd which is numeric but actually
+      // a format.
+      $output->formattedValue = $value;
+    } elseif ($value !== null) {
       $today = new \DateTime();
+      $date = new \DateTime($value);
+      if (strlen($value) == 10 && is_numeric($value)) {
+        $date = \DateTime::createFromFormat('Ymd', $value);
+      }
       $age = $today->diff($date);
       $output->rawValue = $age->format('%y');
       $output->formattedValue = $output->rawValue;
@@ -141,13 +152,21 @@ class AgeFieldOutputHandler extends AbstractSimpleFieldOutputHandler implements
    * @return mixed
    */
   public function formatAggregationValue($value) {
-    $availableFunctions = $this->getFunctions();
-    if ($this->function && isset($availableFunctions[$this->function]) && $value) {
+    // Check whether the value is a number.
+    // When it is a number the age has been calculated in the database.
+    // If not we have to calculate the age.
+    if (is_numeric($value) && strlen($value) != 10) {
+      // We check for strlen as civicrm format is yyyymmdd which is numeric but actually
+      // a format.
+      return $value;
+    } else {
+      $today = new \DateTime();
       $date = new \DateTime($value);
-      $value = $date->format($availableFunctions[$this->function]['php_date_format']);
-      if (isset($availableFunctions[$this->function]['php_add'])) {
-        $value = $value + $availableFunctions[$this->function]['php_add'];
+      if (strlen($value) == 10 && is_numeric($value)) {
+        $date = \DateTime::createFromFormat('Ymd', $value);
       }
+      $age = $today->diff($date);
+      return $age->format('%y');
     }
     return $value;
   }