fix form submission, when form block is inside another block

[sukhwinder-somar]

Creating new PR, related to the dnadesign/silverstripe-elemental-userforms#78

Issue

• Submitting Form Causes Error dnadesign/silverstripe-elemental-userforms#27

[GuySartorelli]

Please change to this instead:

public function handleElement()
{
    $id = $this->owner->getRequest()->param('ID');

    if (!$id) {
        user_error('No element ID supplied', E_USER_ERROR);
        return false;
    }

    /** @var DataObject $elementOwner */
    $elementOwner = $this->owner->data();

    if (!$elementOwner->hasExtension(ElementalAreasExtension::class)) {
        user_error(get_class($elementOwner) . ' doesnt have the ElementalAreasExtension applied', E_USER_ERROR);
        return false;
    }

    $elementalAreaRelations = $elementOwner->getElementalRelations();
    if (!$elementalAreaRelations) {
        user_error(get_class($elementOwner) . ' has no ElementalArea relationships', E_USER_ERROR);
        return false;
    }

    $element = $this->findElement($elementalAreaRelations, $elementOwner, $id);

    if ($element) {
        return $element->getController();
    }

    user_error('Element $id not found for this page', E_USER_ERROR);
    return false;
}

private function findElement(iterable $elementalAreaRelations, DataObject $owner, $id): ?DataObject
{
    foreach ($elementalAreaRelations as $elementalAreaRelation) {
        $elements = $owner->$elementalAreaRelation()->Elements();
        $found = $elements->filter('ID', $id)->First();

        if ($found) {
            return $found;
        }

        /** @var BaseElement $element */
        foreach ($elements as $element)             {
            if (!$element->hasExtension(ElementalAreasExtension::class)) {
                continue;
            }

            /** @var BaseElement&ElementalAreasExtension $element */
            $found = $this->findElement($element->getElementalRelations(), $element, $id);

            if ($found) {
                return $found;
            }
        }
    }

    return null;
}

This is similar to your approach, but with the following key differences:

• Adds an additional protection against $elementOwner not having the ElementalAreasExtension applied (in the case of custom nested elements)
• Checks for use of the ElementalAreasExtension instead of the Elements method, which allows for the relation to have any arbitrary name instead of just the one that the elemental list module uses
• Flips the logic of findElement() somewhat, so we have no foreach loop in the handleElement() anymore, delegating all of the logic to findElement().
• Adds appropriate type hinting to the new method

I've tested this in conjunction with dnadesign/silverstripe-elemental-userforms#78 and together they resolve the bug, so after you've made these changes I'll be happy to merge them both.

[sukhwinder-somar]

sweet, I have updated the code with your changes, but I didn't test it so I'm hoping it will work as you have already tested it....

[sukhwinder-somar]

sweet, I have updated the code with your changes, but I didn't tested it so I'm hoping it will work as you have already tested it....

[GuySartorelli]

Please test the changes. I will merge once you have confirmed they work on your end.
The whole point of a pull request is that there are at least two people involved.

[sukhwinder-somar]

Sure, then I will update you tomorrow or tonight after testing...

[sukhwinder-somar]

Hi,

I have tested this and can confirm the above is working for me on First and Second Level of page.

While testing I had first and second level forms on same page and I found out If I was submitting one of them, then both of them was showing confirmation messages, which I feel looks weird, so thought I should tell you....

thanks,

[GuySartorelli]

While testing I had first and second level forms on same page and I found out If I was submitting one of them, then both of them was showing confirmation messages, which I feel looks weird, so thought I should tell you....

That's a known issue, captured in dnadesign/silverstripe-elemental-userforms#50 - it was fixed recently so if you update your dependency it shouldn't happen anymore.

[GuySartorelli]

Looks good to me, thanks for fixing this.

[GuySartorelli]

Ahh, sorry, I just realised this is targetting the wrong branch.
Please retarget it to the 4.11 branch. You may need to reset your commits afterward.

[sukhwinder-somar]

All good, thanks for all support 😊 🙏

[GuySartorelli]

Oops, looks like when you reset the commits you accidentally reverted the changes from #1107 (review) as well!

[sukhwinder-somar]

apologies again, I forgot to cherry pick both commits, but have added it now 😅