Merge pull request #62 from systopia/checkbox-required-initially-unch…

…ecked Checkbox: Allow required checkboxes that are initially unchecked
systopia · Jul 9, 2024 · 2e92c7b · 2e92c7b
2 parents e7cf3a6 + 24dbd8c
commit 2e92c7b
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 3 deletions.
diff --git a/src/Form/Control/CheckboxArrayFactory.php b/src/Form/Control/CheckboxArrayFactory.php
@@ -42,11 +42,19 @@ public function createFormArray(
   ): array {
     Assertion::isInstanceOf($definition, ControlDefinition::class);
     /** @var \Drupal\json_forms\JsonForms\Definition\Control\ControlDefinition $definition */
-    return [
+    $form = [
       '#type' => 'checkbox',
-      '#required' => FALSE,
+      '#required' => TRUE === $definition->getConst(),
       '#value_callback' => CheckboxValueCallback::class . '::convert',
     ] + BasicFormPropertiesFactory::createFieldProperties($definition, $formState);
+
+    if (FALSE === $definition->getDefault() && TRUE === $definition->getConst()) {
+      // Don't initially check checkbox, if it is required, but its default is
+      // false.
+      unset($form['#value']);
+    }
+
+    return $form;
   }
 
   public function supportsDefinition(DefinitionInterface $definition): bool {

diff --git a/tests/src/Unit/Form/Control/CheckboxArrayFactoryTest.php b/tests/src/Unit/Form/Control/CheckboxArrayFactoryTest.php
@@ -89,7 +89,7 @@ public function testCreateFormArraySimple(): void {
     static::assertEquals($expected, $form);
   }
 
-  public function testCreateFormArray(): void {
+  public function testCreateFormArrayRequired(): void {
     $jsonSchema = (object) [
       'type' => 'object',
       'properties' => (object) [
@@ -99,6 +99,7 @@ public function testCreateFormArray(): void {
             'foo' => (object) [
               'type' => 'boolean',
               'description' => 'Test description',
+              'const' => TRUE,
             ],
           ],
           'required' => ['foo'],
@@ -123,6 +124,7 @@ public function testCreateFormArray(): void {
       '#value_callback' => CheckboxValueCallback::class . '::convert',
       '#disabled' => TRUE,
       '#required' => TRUE,
+      '#value' => TRUE,
       '#parents' => ['test', 'foo'],
       '#title' => 'Test',
       // phpcs:disable DrupalPractice.General.DescriptionT.DescriptionT
@@ -135,6 +137,47 @@ public function testCreateFormArray(): void {
     static::assertEquals($expected, $form);
   }
 
+  public function testCreateFormArrayRequiredDefaultFalse(): void {
+    $jsonSchema = (object) [
+      'type' => 'object',
+      'properties' => (object) [
+        'test' => (object) [
+          'type' => 'object',
+          'properties' => (object) [
+            'foo' => (object) [
+              'type' => 'boolean',
+              'const' => TRUE,
+              'default' => FALSE,
+            ],
+          ],
+          'required' => ['foo'],
+        ],
+      ],
+    ];
+
+    $uiSchema = (object) [
+      'type' => 'Control',
+      'scope' => '#/properties/test/properties/foo',
+    ];
+
+    $definition = ControlDefinition::fromJsonSchema($uiSchema, $jsonSchema, FALSE);
+    $form = $this->factory->createFormArray($definition, $this->formState, $this->formArrayFactoryMock);
+
+    $expected = [
+      '#type' => 'checkbox',
+      '#value_callback' => CheckboxValueCallback::class . '::convert',
+      '#disabled' => FALSE,
+      '#required' => TRUE,
+      '#default_value' => FALSE,
+      '#parents' => ['test', 'foo'],
+      '#title' => 'Foo',
+      '#tree' => TRUE,
+      '#limit_validation_errors' => [],
+      '#_scope' => '#/properties/test/properties/foo',
+    ];
+    static::assertEquals($expected, $form);
+  }
+
   public function testSupportsDefinition(): void {
     $jsonSchema = (object) [
       'type' => 'object',