Add support for read only fields

systopia · Jul 26, 2024 · da2a8d1 · da2a8d1
1 parent c82eb20
commit da2a8d1
Show file tree

Hide file tree

Showing 12 changed files with 352 additions and 88 deletions.
diff --git a/Civi/RemoteTools/ActionHandler/AbstractProfileEntityActionsHandler.php b/Civi/RemoteTools/ActionHandler/AbstractProfileEntityActionsHandler.php
@@ -38,6 +38,7 @@
 use Civi\RemoteTools\EntityProfile\Helper\ProfileEntityLoaderInterface;
 use Civi\RemoteTools\EntityProfile\RemoteEntityProfileInterface;
 use Civi\RemoteTools\Form\FormSpec\FormSpec;
+use Civi\RemoteTools\Form\FormSpec\Util\ReadOnlyFieldsRemover;
 use Civi\RemoteTools\Form\Validation\ValidationResult;
 use CRM_Remotetools_ExtensionUtil as E;
 
@@ -219,7 +220,7 @@ public function submitCreateForm(RemoteSubmitCreateFormAction $action
     $createdValues = $this->api4->createEntity(
       $this->profile->getEntityName(),
       $formSpec->getDataTransformer()->toEntityValues(
-        $action->getData(),
+        ReadOnlyFieldsRemover::removeReadOnlyFields($formSpec, $action->getData()),
         NULL,
         $action->getResolvedContactId()
       ),
@@ -259,7 +260,7 @@ public function submitUpdateForm(RemoteSubmitUpdateFormAction $action
     }
 
     $newEntityValues = $formSpec->getDataTransformer()->toEntityValues(
-      $action->getData(),
+      ReadOnlyFieldsRemover::removeReadOnlyFields($formSpec, $action->getData()),
       $entityValues,
       $action->getResolvedContactId()
     );

diff --git a/Civi/RemoteTools/Api4/Action/RemoteSubmitCreateFormAction.php b/Civi/RemoteTools/Api4/Action/RemoteSubmitCreateFormAction.php
@@ -25,7 +25,7 @@
 /**
  * @api
  */
-final class RemoteSubmitCreateFormAction extends AbstractProfileAwareRemoteAction {
+class RemoteSubmitCreateFormAction extends AbstractProfileAwareRemoteAction {
 
   use ArgumentsParameterOptionalTrait;
 

diff --git a/Civi/RemoteTools/Api4/Action/RemoteSubmitUpdateFormAction.php b/Civi/RemoteTools/Api4/Action/RemoteSubmitUpdateFormAction.php
@@ -25,7 +25,7 @@
 /**
  * @api
  */
-final class RemoteSubmitUpdateFormAction extends AbstractProfileAwareRemoteAction {
+class RemoteSubmitUpdateFormAction extends AbstractProfileAwareRemoteAction {
 
   use DataParameterTrait;
 

diff --git a/Civi/RemoteTools/Api4/Action/RemoteValidateUpdateFormAction.php b/Civi/RemoteTools/Api4/Action/RemoteValidateUpdateFormAction.php
@@ -25,7 +25,7 @@
 /**
  * @api
  */
-final class RemoteValidateUpdateFormAction extends AbstractProfileAwareRemoteAction {
+class RemoteValidateUpdateFormAction extends AbstractProfileAwareRemoteAction {
 
   use DataParameterTrait;
 

diff --git a/Civi/RemoteTools/Form/FormSpec/AbstractFormField.php b/Civi/RemoteTools/Form/FormSpec/AbstractFormField.php
@@ -14,6 +14,8 @@ abstract class AbstractFormField extends AbstractFormInput {
 
   private bool $required = FALSE;
 
+  private bool $readOnly = FALSE;
+
   private ?bool $nullable = NULL;
 
   private bool $hasDefaultValue = FALSE;
@@ -41,6 +43,19 @@ public function setRequired(bool $required): self {
     return $this;
   }
 
+  public function isReadOnly(): bool {
+    return $this->readOnly;
+  }
+
+  /**
+   * @return $this
+   */
+  public function setReadOnly(bool $readOnly): self {
+    $this->readOnly = $readOnly;
+
+    return $this;
+  }
+
   public function isNullable(): bool {
     return NULL === $this->nullable ? !$this->isRequired() : $this->nullable;
   }

diff --git a/Civi/RemoteTools/Form/FormSpec/Util/ReadOnlyFieldsRemover.php b/Civi/RemoteTools/Form/FormSpec/Util/ReadOnlyFieldsRemover.php
@@ -0,0 +1,25 @@
+<?php
+declare(strict_types = 1);
+
+namespace Civi\RemoteTools\Form\FormSpec\Util;
+
+use Civi\RemoteTools\Form\FormSpec\FormSpec;
+
+final class ReadOnlyFieldsRemover {
+
+  /**
+   * @phpstan-param array<string, mixed> $values
+   *
+   * @phpstan-return array<string, mixed>
+   */
+  public static function removeReadOnlyFields(FormSpec $formSpec, array $values): array {
+    foreach ($formSpec->getFields() as $field) {
+      if ($field->isReadOnly()) {
+        unset($values[$field->getName()]);
+      }
+    }
+
+    return $values;
+  }
+
+}
diff --git a/Civi/RemoteTools/JsonSchema/FormSpec/Factory/BooleanFieldFactory.php b/Civi/RemoteTools/JsonSchema/FormSpec/Factory/BooleanFieldFactory.php
@@ -30,6 +30,9 @@ public function createSchema(AbstractFormField $field): JsonSchema {
     if ($field->hasDefaultValue()) {
       $keywords['default'] = $field->getDefaultValue();
     }
+    if ($field->isReadOnly()) {
+      $keywords['readOnly'] = TRUE;
+    }
 
     return new JsonSchemaBoolean($keywords, $field->isNullable());
   }

diff --git a/Civi/RemoteTools/JsonSchema/FormSpec/Factory/IntegerFieldFactory.php b/Civi/RemoteTools/JsonSchema/FormSpec/Factory/IntegerFieldFactory.php
@@ -31,6 +31,9 @@ public function createSchema(AbstractFormField $field): JsonSchema {
     if ($field->hasDefaultValue()) {
       $keywords['default'] = $field->getDefaultValue();
     }
+    if ($field->isReadOnly()) {
+      $keywords['readOnly'] = TRUE;
+    }
     if ($field instanceof AbstractNumberField) {
       if (NULL !== $field->getMaximum()) {
         $keywords['maximum'] = $field->getMaximum();

diff --git a/Civi/RemoteTools/JsonSchema/FormSpec/Factory/NumberFieldFactory.php b/Civi/RemoteTools/JsonSchema/FormSpec/Factory/NumberFieldFactory.php
@@ -36,6 +36,9 @@ public function createSchema(AbstractFormField $field): JsonSchema {
     if ($field->hasDefaultValue()) {
       $keywords['default'] = $field->getDefaultValue();
     }
+    if ($field->isReadOnly()) {
+      $keywords['readOnly'] = TRUE;
+    }
     if ($field instanceof AbstractNumberField) {
       if (NULL !== $field->getMaximum()) {
         $keywords['maximum'] = $field->getMaximum();

diff --git a/Civi/RemoteTools/JsonSchema/FormSpec/Factory/OptionFieldFactory.php b/Civi/RemoteTools/JsonSchema/FormSpec/Factory/OptionFieldFactory.php
@@ -49,6 +49,9 @@ public function createSchema(AbstractFormField $field): JsonSchema {
     if ($field->hasDefaultValue()) {
       $keywords['default'] = $field->getDefaultValue();
     }
+    if ($field->isReadOnly()) {
+      $keywords['readOnly'] = TRUE;
+    }
 
     return new JsonSchema($keywords);
   }

diff --git a/Civi/RemoteTools/JsonSchema/FormSpec/Factory/StringFieldFactory.php b/Civi/RemoteTools/JsonSchema/FormSpec/Factory/StringFieldFactory.php
@@ -35,6 +35,9 @@ public function createSchema(AbstractFormField $field): JsonSchema {
     if ($field->hasDefaultValue()) {
       $keywords['default'] = $field->getDefaultValue();
     }
+    if ($field->isReadOnly()) {
+      $keywords['readOnly'] = TRUE;
+    }
     if ($field instanceof AbstractTextField) {
       if (NULL !== $field->getMaxLength()) {
         $keywords['maxLength'] = $field->getMaxLength();