Filter data nested forms

docs/guide/en/displaying-fields.md

@@ -9,6 +9,13 @@ use Yiisoft\FormModel\FormModel;
 
 /** @var FormModel $formModel */
 $field = Field::text($formModel, 'login');
+
+/** Display fields nested forms */
+$nestedField = Field::text($formModel->nestedForm, 'text');
+/** or dot-notation */
+$nestedField = Field::text($formModel, 'nestedForm.text');
+/** or array notation */
+$nestedField = Field::text($formModel, 'nestedForm[text]');
 ```
 
 or factory (`\Yiisoft\FormModel\FieldFactory`):
@@ -20,6 +27,13 @@ use Yiisoft\FormModel\FormModel;
 /** @var FormModel $formModel */
 $factory = new FieldFactory();
 $factory->text($formModel, 'login');
+
+/** Display nested form field */
+$nestedField = $factory->text($formModel->nestedForm, 'text');
+/** or dot-notation */
+$nestedField = $factory->text($formModel, 'nestedForm.text');
+/** or array notation */
+$nestedField = $factory->text($formModel, 'nestedForm[text]');
 ```
 
 If you want to customize other properties, such as label, hint, etc., use dedicated methods:

src/FormHydrator.php

@@ -68,7 +68,9 @@
             if (!isset($data[$scope]) || !is_array($data[$scope])) {
                 return false;
             }
-            $hydrateData = $data[$scope];
+
+            $filteredData = $this->filterDataNestedForms($model,$data);
+            $hydrateData = array_merge_recursive($data[$model->getFormName()], $filteredData);
         }
 
         $this->hydrator->hydrate(
@@ -251,4 +253,34 @@
         }
         return $result;
     }
+
+    private function filterDataNestedForms(FormModelInterface $formModel, array &$data): array
+    {
+        $reflection = new \ReflectionClass($formModel);
+        $properties = $reflection->getProperties(\ReflectionProperty::IS_PUBLIC);
+
+        $filteredData = [];
+        foreach ($properties as $property) {
+            if ($property->isStatic()) {
+                continue;
+            }
+
+            if ($property->isReadOnly() && $property->isInitialized($formModel)) {
+                continue;
+            }
+
+            $propertyValue = $property->getValue($formModel);
+            if ($propertyValue instanceof FormModel) {
+                $dataNestedForms = $this->filterDataNestedForms($property->getValue($formModel), $data);
+                if (isset($data[$propertyValue->getFormName()])) {
+                    $filteredData[$property->getName()] = array_merge($data[$propertyValue->getFormName()], $dataNestedForms);
+                    unset($data[$propertyValue->getFormName()]);
+                } else if (!empty($dataNestedForms)) {
+                    $filteredData[$property->getName()] = $dataNestedForms;
+                }
+            }
+        }
+
+        return $filteredData;
+    }
 }

tests/FormHydratorTest.php

@@ -10,6 +10,7 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Yiisoft\FormModel\FormModel;
 use Yiisoft\FormModel\Tests\Support\Form\CarForm;
+use Yiisoft\FormModel\Tests\Support\Form\PopulateNestedForm\MainForm;
 use Yiisoft\FormModel\Tests\Support\TestHelper;
 use Yiisoft\Validator\Result;
 use Yiisoft\Validator\Rule\Integer;
@@ -146,6 +147,95 @@ public function testPopulateFromPostAndValidate(bool $expected, ServerRequestInt
         $this->assertSame($expected, $result);
     }
 
+    public static function dataNestedPopulate(): array
+    {
+        $factory = new ServerRequestFactory();
+        $expected = [
+            'value' => 'test',
+            'firstForm' => 'firstTest',
+            'secondForm' => 3,
+            'secondForm.string' => 'string'
+        ];
+        return [
+            'nested-array-data' => [
+                $expected,
+                $factory->createServerRequest('POST', '/')->withParsedBody([
+                    'MainForm' => [
+                        'value' => $expected['value'],
+                        'firstForm' => [
+                            'value' => $expected['firstForm'],
+                            'secondForm' => [
+                                'value' => $expected['secondForm'],
+                                'string' => $expected['secondForm.string']
+                            ]
+                        ]
+                    ]
+                ]),
+            ],
+            'dot-notation-data' => [
+                $expected,
+                $factory->createServerRequest('POST', '/')->withParsedBody([
+                    'MainForm' => [
+                        'value' => $expected['value'],
+                        'firstForm.value' => $expected['firstForm'],
+                        'firstForm.secondForm.value' => $expected['secondForm'],
+                        'firstForm.secondForm.string' => $expected['secondForm.string']
+                    ]
+                ]),
+            ],
+            'one-level-array-data' => [
+                $expected,
+                $factory->createServerRequest('POST', '/')->withParsedBody([
+                    'MainForm' => ['value' => $expected['value']],
+                    'FirstNestedForm' => ['value' => $expected['firstForm']],
+                    'SecondNestedForm' => ['value' => $expected['secondForm'], 'string' => $expected['secondForm.string']],
+                ]),
+            ],
+            'mixed-one-level-and-dot-notation-data' => [
+                $expected,
+                $factory->createServerRequest('POST', '/')->withParsedBody([
+                    'MainForm' => [
+                        'value' => $expected['value'],
+                        'firstForm.secondForm.string' => $expected['secondForm.string'],
+                    ],
+                    'FirstNestedForm' => [
+                        'value' => $expected['firstForm'],
+                        'secondForm.value' => $expected['secondForm'],
+                    ]
+                ])
+            ],
+            'mixed-one-level-and-nested-array-data' => [
+                $expected,
+                $factory->createServerRequest('POST', '/')->withParsedBody([
+                    'MainForm' => [
+                        'value' => $expected['value'],
+                        'firstForm' => [
+                            'value' => $expected['firstForm'],
+                            'secondForm' => [
+                                'string' => $expected['secondForm.string'],
+                            ]
+                        ],
+                    ],
+                    'SecondNestedForm' => [
+                        'value' => $expected['secondForm'],
+                    ],
+                ])
+            ],
+        ];
+    }
+
+    #[DataProvider('dataNestedPopulate')]
+    public function testPopulateNestedFormFromPost(array $expected, ServerRequestInterface $request): void
+    {
+        $form  = new MainForm();
+
+        TestHelper::createFormHydrator()->populateFromPost($form, $request);
+        $this->assertSame($expected['value'], $form->value);
+        $this->assertSame($expected['firstForm'], $form->firstForm->value);
+        $this->assertSame($expected['secondForm'], $form->firstForm->secondForm->value);
+        $this->assertSame($expected['secondForm.string'], $form->firstForm->secondForm->string);
+    }
+
     public function testPopulateFormWithRulesFromAttributesAndMethod(): void
     {
         $form = new class () extends FormModel implements RulesProviderInterface {

tests/Support/Form/PopulateNestedForm/FirstNestedForm.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+
+namespace Yiisoft\FormModel\Tests\Support\Form\PopulateNestedForm;
+
+
+use Yiisoft\FormModel\FormModel;
+use Yiisoft\Validator\Rule\Length;
+use Yiisoft\Validator\Rule\Nested;
+use Yiisoft\Validator\Rule\Required;
+use Yiisoft\Validator\Rule\StringValue;
+
+class FirstNestedForm extends FormModel {
+
+    #[Required]
+    #[StringValue]
+    #[Length(min: 3)]
+    public string $value = '';
+
+    #[Required]
+    #[Nested(SecondNestedForm::class)]
+    public SecondNestedForm $secondForm;
+
+    public function __construct() {
+        $this->secondForm = new SecondNestedForm();
+    }
+}

tests/Support/Form/PopulateNestedForm/MainForm.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\FormModel\Tests\Support\Form\PopulateNestedForm;
+
+use Yiisoft\FormModel\FormModel;
+use Yiisoft\Validator\Rule\Length;
+use Yiisoft\Validator\Rule\Nested;
+use Yiisoft\Validator\Rule\Required;
+use Yiisoft\Validator\Rule\StringValue;
+
+
+class MainForm extends FormModel {
+
+    #[Nested(FirstNestedForm::class)]
+    public FirstNestedForm $firstForm;
+
+    #[Required]
+    #[StringValue]
+    #[Length(min: 3)]
+    public string $value = '';
+
+    public function __construct() {
+        $this->firstForm = new FirstNestedForm();
+    }
+}

tests/Support/Form/PopulateNestedForm/SecondNestedForm.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+
+namespace Yiisoft\FormModel\Tests\Support\Form\PopulateNestedForm;
+
+use Yiisoft\FormModel\FormModel;
+use Yiisoft\Validator\Rule\Integer;
+use Yiisoft\Validator\Rule\Length;
+use Yiisoft\Validator\Rule\Required;
+use Yiisoft\Validator\Rule\StringValue;
+
+class SecondNestedForm extends FormModel {
+
+    #[Required]
+    #[Integer]
+    public int $value = 0;
+
+    #[Required]
+    #[StringValue]
+    #[Length(min: 4)]
+    public string $string = '';
+
+    public function __construct() {}
+}