Pass api4 getFields values through to getOptions

civicrm · Dec 31, 2019 · f53bad0 · f53bad0
1 parent 8830e2e
commit f53bad0
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 5 deletions.
diff --git a/Civi/Api4/Generic/DAOGetFieldsAction.php b/Civi/Api4/Generic/DAOGetFieldsAction.php
@@ -52,7 +52,7 @@ protected function getRecords() {
       $this->includeCustom = strpos(implode('', $fields), '.') !== FALSE;
     }
     $spec = $gatherer->getSpec($this->getEntityName(), $this->getAction(), $this->includeCustom, $this->values);
-    return SpecFormatter::specToArray($spec->getFields($fields), $this->loadOptions);
+    return SpecFormatter::specToArray($spec->getFields($fields), $this->loadOptions, $this->values);
   }
 
   public function fields() {

diff --git a/Civi/Api4/Service/Spec/FieldSpec.php b/Civi/Api4/Service/Spec/FieldSpec.php
@@ -376,9 +376,10 @@ private function getValidDataTypes() {
   }
 
   /**
+   * @param array $values
    * @return array
    */
-  public function getOptions() {
+  public function getOptions($values = []) {
     if (!isset($this->options) || $this->options === TRUE) {
       $fieldName = $this->getName();
 
@@ -388,7 +389,7 @@ public function getOptions() {
       }
 
       $bao = CoreUtil::getBAOFromApiName($this->getEntity());
-      $options = $bao::buildOptions($fieldName);
+      $options = $bao::buildOptions($fieldName, NULL, $values);
 
       if (!is_array($options) || !$options) {
         $options = FALSE;

diff --git a/Civi/Api4/Service/Spec/SpecFormatter.php b/Civi/Api4/Service/Spec/SpecFormatter.php
@@ -29,15 +29,16 @@ class SpecFormatter {
   /**
    * @param FieldSpec[] $fields
    * @param bool $includeFieldOptions
+   * @param array $values
    *
    * @return array
    */
-  public static function specToArray($fields, $includeFieldOptions = FALSE) {
+  public static function specToArray($fields, $includeFieldOptions = FALSE, $values = []) {
     $fieldArray = [];
 
     foreach ($fields as $field) {
       if ($includeFieldOptions) {
-        $field->getOptions();
+        $field->getOptions($values);
       }
       $fieldArray[$field->getName()] = $field->toArray();
     }

diff --git a/tests/phpunit/api/v4/Action/GetExtraFieldsTest.php b/tests/phpunit/api/v4/Action/GetExtraFieldsTest.php
@@ -22,6 +22,7 @@
 namespace api\v4\Action;
 
 use api\v4\UnitTestCase;
+use Civi\Api4\Address;
 use Civi\Api4\Contact;
 
 /**
@@ -42,4 +43,17 @@ public function testBAOFieldsWillBeReturned() {
     $this->assertEmpty($notReturned);
   }
 
+  public function testGetOptionsAddress() {
+    $getFields = Address::getFields()->setCheckPermissions(FALSE)->addWhere('name', '=', 'state_province_id')->setLoadOptions(TRUE);
+
+    $usOptions = $getFields->setValues(['country_id' => 1228])->execute()->first();
+
+    $this->assertContains('Alabama', $usOptions['options']);
+    $this->assertNotContains('Alberta', $usOptions['options']);
+
+    $caOptions = $getFields->setValues(['country_id' => 1039])->execute()->first();
+
+    $this->assertNotContains('Alabama', $caOptions['options']);
+    $this->assertContains('Alberta', $caOptions['options']);
+  }
 }