Merge pull request #20440 from colemanw/apiCalculatedField

[REF] APIv4 refactoring to support calculated fields
civicrm · May 31, 2021 · 9bc987c · 9bc987c
2 parents 94f5f09 + e60149f
commit 9bc987c
Show file tree

Hide file tree

Showing 9 changed files with 325 additions and 224 deletions.
diff --git a/Civi/Api4/Action/CustomValue/GetFields.php b/Civi/Api4/Action/CustomValue/GetFields.php
@@ -12,8 +12,6 @@
 
 namespace Civi\Api4\Action\CustomValue;
 
-use Civi\Api4\Service\Spec\SpecFormatter;
-
 /**
  * Get fields for a custom group.
  */
@@ -25,7 +23,7 @@ protected function getRecords() {
     /** @var \Civi\Api4\Service\Spec\SpecGatherer $gatherer */
     $gatherer = \Civi::container()->get('spec_gatherer');
     $spec = $gatherer->getSpec('Custom_' . $this->getCustomGroup(), $this->getAction(), $this->includeCustom, $this->values);
-    return SpecFormatter::specToArray($spec->getFields($fields), $this->loadOptions);
+    return $this->specToArray($spec->getFields($fields));
   }
 
   /**

diff --git a/Civi/Api4/Generic/DAOGetFieldsAction.php b/Civi/Api4/Generic/DAOGetFieldsAction.php
@@ -19,8 +19,6 @@
 
 namespace Civi\Api4\Generic;
 
-use Civi\Api4\Service\Spec\SpecFormatter;
-
 /**
  * @inheritDoc
  * @method bool getIncludeCustom()
@@ -48,7 +46,7 @@ protected function getRecords() {
       $this->includeCustom = strpos(implode('', $fieldsToGet), '.') !== FALSE;
     }
     $spec = $gatherer->getSpec($this->getEntityName(), $this->getAction(), $this->includeCustom, $this->values);
-    $fields = SpecFormatter::specToArray($spec->getFields($fieldsToGet), $this->loadOptions, $this->values);
+    $fields = $this->specToArray($spec->getFields($fieldsToGet));
     foreach ($fieldsToGet ?? [] as $fieldName) {
       if (empty($fields[$fieldName]) && strpos($fieldName, '.') !== FALSE) {
         $fkField = $this->getFkFieldSpec($fieldName, $fields);
@@ -61,6 +59,24 @@ protected function getRecords() {
     return $fields;
   }
 
+  /**
+   * @param \Civi\Api4\Service\Spec\FieldSpec[] $fields
+   *
+   * @return array
+   */
+  protected function specToArray($fields) {
+    $fieldArray = [];
+
+    foreach ($fields as $field) {
+      if ($this->loadOptions) {
+        $field->getOptions($this->values, $this->loadOptions, $this->checkPermissions);
+      }
+      $fieldArray[$field->getName()] = $field->toArray();
+    }
+
+    return $fieldArray;
+  }
+
   /**
    * @param string $fieldName
    * @param array $fields

diff --git a/Civi/Api4/Service/Spec/CustomFieldSpec.php b/Civi/Api4/Service/Spec/CustomFieldSpec.php
@@ -23,17 +23,12 @@ class CustomFieldSpec extends FieldSpec {
   /**
    * @var int
    */
-  protected $customFieldId;
+  public $customFieldId;
 
   /**
    * @var int
    */
-  protected $customGroup;
-
-  /**
-   * @var string
-   */
-  protected $tableName;
+  public $customGroup;
 
   /**
    * @inheritDoc
@@ -91,22 +86,4 @@ public function setCustomGroupName($customGroupName) {
     return $this;
   }
 
-  /**
-   * @return string
-   */
-  public function getCustomTableName() {
-    return $this->tableName;
-  }
-
-  /**
-   * @param string $customFieldColumnName
-   *
-   * @return $this
-   */
-  public function setCustomTableName($customFieldColumnName) {
-    $this->tableName = $customFieldColumnName;
-
-    return $this;
-  }
-
 }