Skip to content
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

implements container.formGroupClass parameter to pass or disable classes #406

Merged
merged 5 commits into from
Nov 20, 2024
Merged

implements container.formGroupClass parameter to pass or disable classes #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8489f2e
implements container.formGroupClass parameter to pass or disable clas…
skie Nov 17, 2024
800d6ad
fix line length issue
skie Nov 17, 2024
074628e
added tests cases covering custom form-group
skie Nov 17, 2024
8b8332c
Merge remote-tracking branch 'parent/next' into form-group
skie Nov 19, 2024
810d6eb
simplify form-group detection logic
skie Nov 20, 2024
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
87 changes: 51 additions & 36 deletions src/View/Helper/FormHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,19 +148,20 @@ class FormHelper extends CoreFormHelper
'{{input}}{{label}}',
'inputContainer' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group {{type}}{{required}}">{{content}}{{help}}</div>',
'class="{{containerClass}}{{formGroupClass}} {{type}}{{required}}">{{content}}{{help}}</div>',
'inputContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group {{formGroupPosition}}{{type}}{{required}} is-invalid">' .
'class="{{containerClass}}{{formGroupClass}} {{formGroupPosition}}{{type}}{{required}} is-invalid">' .
'{{content}}{{error}}{{help}}</div>',
'checkboxContainer' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group form-check{{variant}} ' .
'{{type}}{{required}}">{{content}}{{help}}</div>',
'class="{{containerClass}}{{formGroupClass}} form-check{{variant}} ' .
'{{type}}{{required}}">{{content}}{{help}}</div>',
'checkboxContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group form-check{{variant}} ' .
'{{formGroupPosition}}{{type}}{{required}} is-invalid">{{content}}{{error}}{{help}}</div>',
'class="{{containerClass}}{{formGroupClass}} form-check{{variant}} ' .
'{{formGroupPosition}}{{type}}{{required}} is-invalid">' .
'{{content}}{{error}}{{help}}</div>',
'checkboxInlineContainer' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-check{{variant}} form-check-inline align-top {{type}}{{required}}">' .
Expand All @@ -176,11 +177,11 @@ class FormHelper extends CoreFormHelper
'checkboxInlineWrapper' =>
'<div class="form-check{{variant}} form-check-inline">{{label}}</div>',
'radioContainer' =>
'<div{{containerAttrs}} class="{{containerClass}}form-group {{type}}{{required}}" role="group" ' .
'<div{{containerAttrs}} class="{{containerClass}}{{formGroupClass}} {{type}}{{required}}" role="group" ' .
'aria-labelledby="{{groupId}}">{{content}}{{help}}</div>',
'radioContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group {{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'class="{{containerClass}}{{formGroupClass}} {{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">{{content}}{{error}}{{help}}</div>',
'radioLabel' =>
'<label{{attrs}}>{{text}}{{tooltip}}</label>',
Expand All @@ -195,11 +196,11 @@ class FormHelper extends CoreFormHelper
'inputGroupText' =>
'<span class="input-group-text">{{content}}</span>',
'multicheckboxContainer' =>
'<div{{containerAttrs}} class="{{containerClass}}form-group {{type}}{{required}}" role="group" ' .
'<div{{containerAttrs}} class="{{containerClass}}{{formGroupClass}} {{type}}{{required}}" role="group" ' .
'aria-labelledby="{{groupId}}">{{content}}{{help}}</div>',
'multicheckboxContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group {{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'class="{{containerClass}}{{formGroupClass}} {{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">{{content}}{{error}}{{help}}</div>',
'multicheckboxLabel' =>
'<label{{attrs}}>{{text}}{{tooltip}}</label>',
Expand Down Expand Up @@ -235,21 +236,25 @@ class FormHelper extends CoreFormHelper
'{{formGroupPosition}}{{type}}{{required}} is-invalid">{{content}}{{error}}{{help}}</div>',
'radioContainer' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group {{formGroupPosition}}{{type}}{{required}}" role="group" ' .
'aria-labelledby="{{groupId}}">{{content}}{{help}}</div>',
'class="{{containerClass}}{{formGroupClass}} ' .
'{{formGroupPosition}}{{type}}{{required}}" ' .
'role="group" aria-labelledby="{{groupId}}">' .
'{{content}}{{help}}</div>',
'radioContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group {{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">{{content}}{{error}}{{help}}</div>',
'class="{{containerClass}}{{formGroupClass}} ' .
'{{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">' .
'{{content}}{{error}}{{help}}</div>',
'radioLabel' =>
'<span{{attrs}}>{{text}}{{tooltip}}</span>',
'multicheckboxContainer' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group d-flex {{formGroupPosition}}{{type}}{{required}}" ' .
'class="{{containerClass}}{{formGroupClass}} d-flex {{formGroupPosition}}{{type}}{{required}}" ' .
'role="group" aria-labelledby="{{groupId}}">{{content}}{{help}}</div>',
'multicheckboxContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group d-flex ' .
'class="{{containerClass}}{{formGroupClass}} d-flex ' .
'{{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">{{content}}{{error}}{{help}}</div>',
'multicheckboxLabel' =>
Expand All @@ -271,38 +276,49 @@ class FormHelper extends CoreFormHelper
'checkboxInlineFormGroup' =>
'<div class="%s"><div class="form-check{{variant}} form-check-inline">{{input}}{{label}}</div></div>',
'submitContainer' =>
'<div{{containerAttrs}} class="{{containerClass}}form-group row">' .
'<div{{containerAttrs}} class="{{containerClass}}{{formGroupClass}} row">' .
'<div class="%s">{{content}}</div></div>',
'inputContainer' =>
'<div{{containerAttrs}} class="{{containerClass}}form-group row {{type}}{{required}}">' .
'<div{{containerAttrs}} class="{{containerClass}}{{formGroupClass}} row {{type}}{{required}}">' .
'{{content}}</div>',
'inputContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group row {{formGroupPosition}}{{type}}{{required}} is-invalid">' .
'{{content}}</div>',
'class="{{containerClass}}{{formGroupClass}} row ' .
'{{formGroupPosition}}{{type}}{{required}} is-invalid">' .
'{{content}}</div>',
'checkboxContainer' =>
'<div{{containerAttrs}} class="{{containerClass}}form-group row {{type}}{{required}}">' .
'<div{{containerAttrs}} ' .
'class="{{containerClass}}{{formGroupClass}} row {{type}}{{required}}">' .
'{{content}}</div>',
'checkboxContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group row {{formGroupPosition}}{{type}}{{required}} is-invalid">' .
'{{content}}</div>',
'class="{{containerClass}}{{formGroupClass}} row ' .
'{{formGroupPosition}}{{type}}{{required}} is-invalid">' .
'{{content}}</div>',
'radioContainer' =>
'<div{{containerAttrs}} class="{{containerClass}}form-group row {{type}}{{required}}" role="group" ' .
'aria-labelledby="{{groupId}}">{{content}}</div>',
'<div{{containerAttrs}} ' .
'class="{{containerClass}}{{formGroupClass}} row {{type}}{{required}}" ' .
'role="group" aria-labelledby="{{groupId}}">' .
'{{content}}</div>',
'radioContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group row {{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">{{content}}</div>',
'class="{{containerClass}}{{formGroupClass}} row ' .
'{{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">' .
'{{content}}</div>',
'radioLabel' =>
'<label{{attrs}}>{{text}}{{tooltip}}</label>',
'multicheckboxContainer' =>
'<div{{containerAttrs}} class="{{containerClass}}form-group row {{type}}{{required}}" role="group" ' .
'aria-labelledby="{{groupId}}">{{content}}</div>',
'<div{{containerAttrs}} ' .
'class="{{containerClass}}{{formGroupClass}} row {{type}}{{required}}" ' .
'role="group" aria-labelledby="{{groupId}}">' .
'{{content}}</div>',
'multicheckboxContainerError' =>
'<div{{containerAttrs}} ' .
'class="{{containerClass}}form-group row {{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">{{content}}</div>',
'class="{{containerClass}}{{formGroupClass}} row ' .
'{{formGroupPosition}}{{type}}{{required}} is-invalid" ' .
'role="group" aria-labelledby="{{groupId}}">' .
'{{content}}</div>',
'multicheckboxLabel' =>
'<label{{attrs}}>{{text}}{{tooltip}}</label>',
],
Expand Down Expand Up @@ -582,13 +598,12 @@ protected function _containerOptions(?string $fieldName, array $options): array
$options['container'] = $this->injectClasses('form-floating', (array)($options['container'] ?? []));
}

if (!isset($options['container'])) {
return $options;
}

$containerOptions = $options['container'];
$containerOptions = $options['container'] ?? [];
unset($options['container']);

$options['templateVars']['formGroupClass'] = $containerOptions['formGroupClass'] ?? 'form-group';
unset($containerOptions['formGroupClass']);

if (isset($containerOptions['class'])) {
$options['templateVars']['containerClass'] = $containerOptions['class'] . ' ';
unset($containerOptions['class']);
Expand Down
52 changes: 52 additions & 0 deletions tests/TestCase/View/Helper/FormHelperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1804,4 +1804,56 @@ public function testFloatingLabelPlaceholderGenerationForIdField()
];
$this->assertHtml($expected, $result);
}

public function testFormGroupClassOverride()
{
$this->article['required']['title'] = false;
$this->Form->create($this->article);

$result = $this->Form->control('title', [
'container' => [
'formGroupClass' => 'custom-form-group',
],
]);
$expected = [
['div' => ['class' => 'mb-3 custom-form-group text']],
['label' => ['class' => 'form-label', 'for' => 'title']],
'Title',
'/label',
'input' => [
'type' => 'text',
'name' => 'title',
'id' => 'title',
'class' => 'form-control',
],
'/div',
];
$this->assertHtml($expected, $result);
}

public function testFormGroupClassEmpty()
{
$this->article['required']['title'] = false;
$this->Form->create($this->article);

$result = $this->Form->control('title', [
'container' => [
'formGroupClass' => '',
],
]);
$expected = [
['div' => ['class' => 'mb-3 text']],
['label' => ['class' => 'form-label', 'for' => 'title']],
'Title',
'/label',
'input' => [
'type' => 'text',
'name' => 'title',
'id' => 'title',
'class' => 'form-control',
],
'/div',
];
$this->assertHtml($expected, $result);
}
}