Skip to content

Mark all parent accordions/tabs if validation exception of control inside #1835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mkrecek234 wants to merge 6 commits into
base: develop
Choose a base branch
from
Draft

Mark all parent accordions/tabs if validation exception of control inside #1835

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
621d33f
Open first accordion if validation exception of control inside
mkrecek234 Aug 28, 2022
70d6bde
Further changes
mkrecek234 Aug 28, 2022
39fb4b4
Fix CS, phpstan
mkrecek234 Aug 29, 2022
7ae4051
Fix CS
mkrecek234 Aug 29, 2022
4fac97a
Fix phpstan
mkrecek234 Aug 29, 2022
14bf730
WIP warning icon
mvorisek Aug 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions demos/form/form.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,16 @@
$group->addControl('surname');
$group->addControl('gender', [Form\Control\Dropdown::class, 'values' => ['Female', 'Male']]);

$accordionLayout = $form->layout->addSubLayout([Form\Layout\Section\Accordion::class]);
$details = $accordionLayout->addSection('Validating Field in Accordion');
Comment thread
mkrecek234 marked this conversation as resolved.

// testing 0 value
$values = [0 => 'noob', 1 => 'pro', 2 => 'dev'];
$form->addControl('description', [Form\Control\Textarea::class])->set(0);
$form->addControl('no_description', [Form\Control\Textarea::class])->set(null);
$form->addControl('status_optional', [Form\Control\Dropdown::class, 'values' => $values]);
$form->addControl('status_string_not-nullable', [Form\Control\Dropdown::class], ['type' => 'string', 'values' => $values, 'nullable' => false]);
$form->addControl('status_integer_not-nullable', [Form\Control\Dropdown::class], ['type' => 'integer', 'values' => $values, 'nullable' => false]);
$details->addControl('status_string_not-nullable', [Form\Control\Dropdown::class], ['type' => 'string', 'values' => $values, 'nullable' => false]);
$details->addControl('status_integer_not-nullable', [Form\Control\Dropdown::class], ['type' => 'integer', 'values' => $values, 'nullable' => false]);
$form->addControl('status_string_required', [Form\Control\Dropdown::class], ['type' => 'string', 'values' => $values, 'required' => true]);
$form->addControl('status_integer_required', [Form\Control\Dropdown::class], ['type' => 'integer', 'values' => $values, 'required' => true]);

Expand Down
3 changes: 3 additions & 0 deletions phpstan.neon.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ parameters:
-
path: 'demos/form/form.php'
message: '~^Call to an undefined method Atk4\\Ui\\JsChain::checkbox\(\)\.$~'
-
path: 'demos/form/form.php'
message: '~^Call to an undefined method Atk4\\Ui\\Form\\Layout::addSection\(\)\.$~'
-
path: 'demos/form/form2.php'
message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::addAction\(\)\.$~'
Expand Down
8 changes: 8 additions & 0 deletions src/Form.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,16 @@ public function onSubmit(\Closure $callback)
return $response;
} catch (ValidationException $e) {
$response = [];
$openFirstSectionOnError = false;

foreach ($e->errors as $field => $error) {
$response[] = $this->error($field, $error);

// If field inside Accordion section does not validate, open first AccordionSection
if (!$openFirstSectionOnError && $this->getControl($field)->getOwner()->getOwner() instanceof \Atk4\Ui\AccordionSection) {
Copy link
Copy Markdown
Member

@mvorisek mvorisek Aug 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this smells to me - getOwner()->getOwner() and below even triple times it seems it is single purpose code only and for more layout nesting it will not work

also, ideally it should not be handled in Form, as form should not care about it's childs too much

also Behat test should be added, so this code is covered - otherwise the logic might break soon - once you will satisfy all CI tests, you should see this in CodeCov report

Copy link
Copy Markdown
Contributor Author

@mkrecek234 mkrecek234 Aug 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

getOwner multiple times also is used in other view, like Crud. You are right, nested Accordions are then not supported - but since today it just won't work at all, this is a huge improvement to usability. And to me, nested Accordions in forms really is an edge case which would not be priority to me to support yet.

$response[] = $this->getControl($field)->getOwner()->getOwner()->getOwner()->jsOpen($this->getControl($field)->getOwner()->getOwner());
$openFirstSectionOnError = true;
}
}

return $response;
Expand Down