-
Notifications
You must be signed in to change notification settings - Fork 6
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.
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
IBX-902: Refactored GroupedFields as a separate service #46
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
src/contracts/Content/Form/Provider/GroupedContentFormFieldsProviderInterface.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * @copyright Copyright (C) eZ Systems AS. All rights reserved. | ||
| * @license For full copyright and license information view LICENSE file distributed with this source code. | ||
| */ | ||
| declare(strict_types=1); | ||
|
|
||
| namespace Ibexa\Contracts\ContentForms\Content\Form\Provider; | ||
|
|
||
| interface GroupedContentFormFieldsProviderInterface | ||
| { | ||
| /** | ||
| * @param \Symfony\Component\Form\FormInterface[] $fieldsDataForm | ||
| * @phpstan-return array<string, array<int, string>> Array of fieldGroupIdentifier grouped by fieldGroupName. | ||
| */ | ||
| public function getGroupedFields(array $fieldsDataForm): array; | ||
| } |
40 changes: 40 additions & 0 deletions
40
src/lib/Content/Form/Provider/GroupedContentFormFieldsProvider.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * @copyright Copyright (C) eZ Systems AS. All rights reserved. | ||
| * @license For full copyright and license information view LICENSE file distributed with this source code. | ||
| */ | ||
| declare(strict_types=1); | ||
|
|
||
| namespace Ibexa\ContentForms\Content\Form\Provider; | ||
|
|
||
| use eZ\Publish\Core\Helper\FieldsGroups\FieldsGroupsList; | ||
| use Ibexa\Contracts\ContentForms\Content\Form\Provider\GroupedContentFormFieldsProviderInterface; | ||
|
|
||
| final class GroupedContentFormFieldsProvider implements GroupedContentFormFieldsProviderInterface | ||
| { | ||
| /** @var \eZ\Publish\Core\Helper\FieldsGroups\FieldsGroupsList */ | ||
| private $fieldsGroupsList; | ||
|
|
||
| public function __construct(FieldsGroupsList $fieldsGroupsList) | ||
| { | ||
| $this->fieldsGroupsList = $fieldsGroupsList; | ||
| } | ||
|
|
||
| public function getGroupedFields(array $fieldsDataForm): array | ||
| { | ||
| $fieldsGroups = $this->fieldsGroupsList->getGroups(); | ||
| $groupedFields = []; | ||
|
|
||
| foreach ($fieldsDataForm as $fieldForm) { | ||
| /** @var \EzSystems\EzPlatformContentForms\Data\Content\FieldData $fieldData */ | ||
| $fieldData = $fieldForm->getViewData(); | ||
| $fieldGroupIdentifier = $this->fieldsGroupsList->getFieldGroup($fieldData->fieldDefinition); | ||
| $fieldGroupName = $fieldsGroups[$fieldGroupIdentifier] ?? $this->fieldsGroupsList->getDefaultGroup(); | ||
|
|
||
| $groupedFields[$fieldGroupName][] = $fieldForm->getName(); | ||
| } | ||
|
|
||
| return $groupedFields; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
tests/lib/Content/Form/Provider/GroupedContentFormFieldsProviderTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| <?php | ||
|
|
||
| /** | ||
| * @copyright Copyright (C) eZ Systems AS. All rights reserved. | ||
| * @license For full copyright and license information view LICENSE file distributed with this source code. | ||
| */ | ||
| declare(strict_types=1); | ||
|
|
||
| namespace Ibexa\Tests\ContentForms\Content\Form\Provider; | ||
|
|
||
| use eZ\Publish\API\Repository\Values\Content\Field; | ||
| use eZ\Publish\Core\FieldType\TextLine\Value; | ||
| use eZ\Publish\Core\Helper\FieldsGroups\FieldsGroupsList; | ||
| use eZ\Publish\Core\Repository\Values\ContentType\FieldDefinition; | ||
| use EzSystems\EzPlatformContentForms\Data\Content\FieldData; | ||
| use Ibexa\ContentForms\Content\Form\Provider\GroupedContentFormFieldsProvider; | ||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\Form\FormInterface; | ||
|
|
||
| final class GroupedContentFormFieldsProviderTest extends TestCase | ||
| { | ||
| public function testGetGroupedFields(): void | ||
| { | ||
| $fieldsGroupsListMock = $this->createMock(FieldsGroupsList::class); | ||
| $fieldsGroupsListMock | ||
| ->expects($this->exactly(3)) | ||
| ->method('getFieldGroup') | ||
| ->withConsecutive() | ||
| ->willReturnOnConsecutiveCalls('group_1', 'group_2', 'group_2'); | ||
|
|
||
| $fieldsGroupsListMock | ||
| ->expects($this->once()) | ||
| ->method('getGroups') | ||
| ->willReturn([ | ||
| 'group_1' => 'Group 1', | ||
| 'group_2' => 'Group 2', | ||
| ]); | ||
|
|
||
| $subject = new GroupedContentFormFieldsProvider($fieldsGroupsListMock); | ||
|
|
||
| $form1 = $this->getFormMockWithFieldData( | ||
| 'first_field', | ||
| 'first_field_type', | ||
| ); | ||
|
|
||
| $form2 = $this->getFormMockWithFieldData( | ||
| 'second_field', | ||
| 'second_field_type', | ||
| ); | ||
|
|
||
| $form3 = $this->getFormMockWithFieldData( | ||
| 'third_field', | ||
| 'third_field_type', | ||
| ); | ||
|
|
||
| $result = $subject->getGroupedFields([$form1, $form2, $form3]); | ||
|
|
||
| $expected = [ | ||
| "Group 1" => [ | ||
| 0 => "first_field", | ||
| ], | ||
| "Group 2" => [ | ||
| 0 => "second_field", | ||
| 1 => "third_field", | ||
| ], | ||
| ]; | ||
|
|
||
| $this->assertEquals($expected, $result); | ||
| } | ||
|
|
||
| /** | ||
| * @return \Symfony\Component\Form\FormInterface | ||
| */ | ||
| private function getFormMockWithFieldData( | ||
| string $fieldDefIdentifier, | ||
| string $fieldTypeIdentifier | ||
| ) { | ||
damianz5 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $formMock = $this | ||
| ->getMockBuilder(FormInterface::class) | ||
| ->disableOriginalConstructor() | ||
| ->getMock(); | ||
| $formMock | ||
| ->expects($this->once()) | ||
| ->method('getViewData') | ||
| ->willReturn(new FieldData([ | ||
| 'field' => new Field(['fieldDefIdentifier' => $fieldDefIdentifier]), | ||
| 'fieldDefinition' => new FieldDefinition(['fieldTypeIdentifier' => $fieldTypeIdentifier]), | ||
| 'value' => new Value('value'), | ||
| ])); | ||
| $formMock | ||
| ->expects($this->once()) | ||
| ->method('getName') | ||
| ->willReturn($fieldDefIdentifier); | ||
|
|
||
| return $formMock; | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH while it's a change to initial implementation, I believe that probably
AbstractType::buildView()from the Form component should have been used instead for grouping data for the form. After all, how fields are grouped should be part of the form itself, not part of a view.Just a note though. Optional.