Skip to content

[Form] check parent types for label_format and translation_domain #39951

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

Merged
merged 1 commit into from
Jan 24, 2021
Merged

[Form] check parent types for label_format and translation_domain #39951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions src/Symfony/Component/Form/Extension/Validator/ViolationMapper/ViolationMapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,11 @@ public function mapViolation(ConstraintViolation $violation, FormInterface $form
$messageTemplate = $violation->getMessageTemplate();

if (false !== strpos($message, '{{ label }}') || false !== strpos($messageTemplate, '{{ label }}')) {
$labelFormat = $scope->getConfig()->getOption('label_format');
$form = $scope;

do {
$labelFormat = $form->getConfig()->getOption('label_format');
} while (null === $labelFormat && null !== $form = $form->getParent());

if (null !== $labelFormat) {
$label = str_replace(
Expand All @@ -180,10 +184,16 @@ public function mapViolation(ConstraintViolation $violation, FormInterface $form
}

if (null !== $this->translator) {
$form = $scope;

do {
$translationDomain = $form->getConfig()->getOption('translation_domain');
} while (null === $translationDomain && null !== $form = $form->getParent());
Copy link

Choose a reason for hiding this comment

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

nit-pick: The loop is a duplicate of the above one. Introduce a private function?

private function getOption($form, $optionLabel) {
  do {
    $option = $form->getConfig()->getOption($optionLabel);
  } while (null === $option && null !== $form = $form->getParent());

  return $option;
}


$label = $this->translator->trans(
$label,
$scope->getConfig()->getOption('label_translation_parameters', []),
$scope->getConfig()->getOption('translation_domain')
$translationDomain
);
}

Expand Down
44 changes: 44 additions & 0 deletions src/Symfony/Component/Form/Tests/Extension/Validator/ViolationMapper/ViolationMapperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1742,6 +1742,50 @@ public function testMessageWithLabelFormat2()
}
}

public function testLabelFormatDefinedByParentType()
{
$form = $this->getForm('', null, null, [], false, true, [
'label_format' => 'form.%name%',
]);
$child = $this->getForm('foo', 'foo');
$form->add($child);

$violation = new ConstraintViolation('Message "{{ label }}"', null, [], null, 'data.foo', null);
$this->mapper->mapViolation($violation, $form);

$errors = iterator_to_array($child->getErrors());

$this->assertCount(1, $errors, $child->getName().' should have an error, but has none');
$this->assertSame('Message "form.foo"', $errors[0]->getMessage());
}

public function testLabelPlaceholderTranslatedWithTranslationDomainDefinedByParentType()
{
$translator = $this->createMock(TranslatorInterface::class);
$translator->expects($this->any())
->method('trans')
->with('foo', [], 'domain')
->willReturn('translated foo label')
;
$this->mapper = new ViolationMapper(null, $translator);

$form = $this->getForm('', null, null, [], false, true, [
'translation_domain' => 'domain',
]);
$child = $this->getForm('foo', 'foo', null, [], false, true, [
'label' => 'foo',
]);
$form->add($child);

$violation = new ConstraintViolation('Message "{{ label }}"', null, [], null, 'data.foo', null);
$this->mapper->mapViolation($violation, $form);

$errors = iterator_to_array($child->getErrors());

$this->assertCount(1, $errors, $child->getName().' should have an error, but has none');
$this->assertSame('Message "translated foo label"', $errors[0]->getMessage());
}

public function testTranslatorNotCalledWithoutLabel()
{
$renderer = $this->getMockBuilder(FormRenderer::class)
Expand Down