Filter data nested forms

[DAGpro]

Q	A
Is bugfix?	✔️
New feature?	✔️
Breaks BC?	❌

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5f56ed6) to head (fe1628f).
Report is 32 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##              master       #68    +/-   ##
============================================
  Coverage     100.00%   100.00%            
- Complexity       257       282    +25     
============================================
  Files             13        15     +2     
  Lines            598       717   +119     
============================================
+ Hits             598       717   +119     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[arogachev]

Hydration of nested form models works for both one-to-one and one-to-many relations - #69. Also the tests are needed. What's the purpose of these changes exactly?

[DAGpro]

@arogachev The purpose of the changes, when working with nested form fields, is for the hydrator to receive the correct data structure.

Field::text($formModel->nestedForm, 'text'); 
Field::text($formModel->nestedForm->seconNestedForm, 'desctioption'); 

[vjik]

1. Nested forms must use map loggic (see FormHydrator::createMap()).
2. Nested forms may be in properties with any variable scope (private/protected/public).

[DAGpro]

2. Вложенные формы могут находиться в свойствах с любой областью действия (частная/защищенная/публичная).

With dot-notation and array it will work without filtering.
Will Field be used with methods?

Field::text($form->nestedForm(), 'text');

[vjik]

With dot-notation and array it will work without filtering.

I think, get a form is developer task. Field::text($form->nestedForm(), 'text'); is ok.

[DAGpro]

1. Nested forms must use map loggic (see FormHydrator::createMap()).

Map logic for nested forms awaits implementation yiisoft/hydrator#97 ?

[vjik]

Map logic for nested forms awaits implementation yiisoft/hydrator#97 ?

Yes, it's need to create nested mapping for hydrator.

[DAGpro]

[
    'firstForm' => Yiisoft\Hydrator\ObjectMap([
        'map' => [
            'secondForm' => Yiisoft\Hydrator\ObjectMap([
                'map' =>
                    [
                        'value' =>
                            [
                                0 => 'firstForm',
                                1 => 'secondForm',
                                2 => 'value',
                            ],
                    ],
            ]),
        ],
    ]),
    'value' => 'value',
];

[
    'firstForm' => Yiisoft\Hydrator\ObjectMap([
        'map' => [
            'secondForm.value' => [
                0 => 'firstForm',
                1 => 'secondForm',
                2 => 'value',
            ],
        ],
    ]),
    'value' => 'value',
];

There is a question of resolving such cases.

When specifying a Nested rule with a null argument on a parent form, ignore the property with the embedded form and the rules from that form?

[vjik]

When specifying a Nested rule with a null argument on a parent form, ignore the property with the embedded form and the rules from that form?

When Nested without rules, then rules from nested object should be used.

[DAGpro]

Review?

[samdark]

Suggested change

	/** Display fields nested forms */
	/** Display nested form */

Does that display whole form?

[DAGpro]

Whole?

nested form field or nested form 🤷‍♂️

[samdark]

@vjik would you please take a look at it?

[vjik]

@DAGpro

Do yiisoft/form widgets support nested forms?
Can you show example of form field HTML for property from nested form?

[DAGpro]

@DAGpro

Поддерживают ли yiisoft/formвиджеты вложенные формы? Можете ли вы показать пример поля формы HTML для свойства из вложенной формы?

Are you interested in using widgets directly from "yiisoft/form" or via the "formModel/Field" helper?

Filling out nested forms is allowed in the filterNestedForms method, error collection for nested forms is allowed in the validator package via the Nested rule class.

When using nested forms directly with the output of errors there are no problems, when using dot-notation and an array, all errors of nested fields are output in the parent field.

[DAGpro]

echo \Yiisoft\FormModel\Field::text($mainForm, 'value');
echo \Yiisoft\FormModel\Field::text($mainForm->firstNestedForm(), 'value');
echo \Yiisoft\FormModel\Field::number($mainForm->firstNestedForm()->secondForm(), 'value');
echo \Yiisoft\FormModel\Field::number($mainForm->firstNestedForm()->secondForm(), 'string');

<div>
    <label for="mainform-value">Value</label>
    <input type="text" id="mainform-value" name="MainForm[value]" value="v">
    <div>Value must contain at least 3 characters.</div>
</div>
<div>
    <label for="firstnestedform-value">Value</label>
    <input type="text" id="firstnestedform-value" name="FirstNestedForm[value]" value="va">
    <div>Value must contain at least 3 characters.</div>
</div>
<div>
    <label for="secondnestedform-value">Value</label>
    <input type="number" id="secondnestedform-value" name="SecondNestedForm[value]">
    <div>
        Value cannot be blank.
        <br>
        The allowed types for value are integer, float and string. null given.
    </div>
</div>
<div>
    <label for="secondnestedform-string">String</label>
    <input type="number" id="secondnestedform-string" name="SecondNestedForm[string]" value>
    <div>
        String cannot be blank.
        <br>
        String must contain at least 4 characters.
    </div>
</div>

echo Text::widget()->inputData(new \Yiisoft\Form\PureField\InputData(
    "MainForm[value]",
    $mainForm->value,
    validationErrors: $mainForm->firstNestedForm()->secondForm()->getValidationResult()->getErrorMessages(),
));
echo Text::widget()->inputData(new \Yiisoft\Form\PureField\InputData(
    "FirstNestedForm[value]",
    $mainForm->firstNestedForm()->value,
    validationErrors: $mainForm->firstNestedForm()->secondForm()->getValidationResult()->getErrorMessages(),
));

echo Text::widget()->inputData(new \Yiisoft\Form\PureField\InputData(
    "SecondNestedForm[value]",
    $mainForm->firstNestedForm()->secondForm()->value,
    validationErrors: $mainForm->firstNestedForm()->secondForm()->getValidationResult()->getErrorMessages(),
));

<div>
    <input type="text" name="MainForm[value]" value="v">
    <div>
        Value cannot be blank.
        <br>
        The allowed types for value are integer, float and string. null given.
        <br>
        String cannot be blank.
        <br>
        String must contain at least 4 characters.
    </div>
</div>
<div>
    <input type="text" name="FirstNestedForm[value]" value="va">
    <div>
        Value cannot be blank.
        <br>
        The allowed types for value are integer, float and string. null given.
        <br>
        String cannot be blank.
        <br>
        String must contain at least 4 characters.
    </div>
</div>
<div>
    <input type="text" name="SecondNestedForm[value]">
    <div>
        Value cannot be blank.
        <br>
        The allowed types for value are integer, float and string. null given.
        <br>
        String cannot be blank.
        <br>
        String must contain at least 4 characters.
    </div>
</div>

[vjik]

This PR required more time for review. Give me more time, I detailed review as soon as possible.