Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions config/services.php
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@
->set(ChoiceFilterConfigurator::class)

->set(CommonFilterConfigurator::class)
->arg(0, service(EntityTranslationIdGeneratorInterface::class))
->tag(EasyAdminExtension::TAG_FILTER_CONFIGURATOR, ['priority' => 9999])

->set(ComparisonFilterConfigurator::class)
Expand Down
18 changes: 16 additions & 2 deletions src/Filter/Configurator/CommonConfigurator.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Filter\FilterConfiguratorInterface;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Translation\EntityTranslationIdGeneratorInterface;
use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
use EasyCorp\Bundle\EasyAdminBundle\Dto\FieldDto;
use EasyCorp\Bundle\EasyAdminBundle\Dto\FilterDto;
Expand All @@ -13,8 +14,13 @@
/**
* @author Javier Eguiluz <javier.eguiluz@gmail.com>
*/
final class CommonConfigurator implements FilterConfiguratorInterface
final readonly class CommonConfigurator implements FilterConfiguratorInterface
{
public function __construct(
private EntityTranslationIdGeneratorInterface $entityTranslationIdGenerator,
) {
}

public function supports(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $entityDto, AdminContext $context): bool
{
return true;
Expand All @@ -27,7 +33,15 @@ public function configure(FilterDto $filterDto, ?FieldDto $fieldDto, EntityDto $
if ($fieldLabel instanceof TranslatableMessage) {
$fieldLabel = $fieldLabel->getMessage();
}
$label = $fieldLabel ?? LabelGenerator::humanize($filterDto->getProperty());

if (null !== $fieldLabel) {
$label = $fieldLabel;
} elseif ($context->isUseEntityTranslations()) {
$label = $this->entityTranslationIdGenerator->generateForProperty($entityDto->getFqcn(), $filterDto->getProperty());
} else {
$label = LabelGenerator::humanize($filterDto->getProperty());
}

$filterDto->setLabel($label);
}
}
Expand Down
142 changes: 142 additions & 0 deletions tests/Unit/Filter/Configurator/CommonConfiguratorTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
<?php

namespace EasyCorp\Bundle\EasyAdminBundle\Tests\Unit\Filter\Configurator;

use Doctrine\ORM\Mapping\ClassMetadata;
use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
use EasyCorp\Bundle\EasyAdminBundle\Context\DashboardContext;
use EasyCorp\Bundle\EasyAdminBundle\Context\I18nContext;
use EasyCorp\Bundle\EasyAdminBundle\Context\RequestContext;
use EasyCorp\Bundle\EasyAdminBundle\Contracts\Translation\EntityTranslationIdGeneratorInterface;
use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
use EasyCorp\Bundle\EasyAdminBundle\Field\TextField;
use EasyCorp\Bundle\EasyAdminBundle\Filter\Configurator\CommonConfigurator;
use EasyCorp\Bundle\EasyAdminBundle\Filter\TextFilter;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Translation\TranslatableMessage;

class CommonConfiguratorTest extends TestCase
{
private EntityDto $entityDto;

protected function setUp(): void
{
$metadata = new ClassMetadata('App\Entity\Product');
$metadata->setIdentifier(['id']);
$this->entityDto = new EntityDto('App\Entity\Product', $metadata);
}

public function testSupportsAllFilters(): void
{
$configurator = $this->createConfigurator();
$filter = TextFilter::new('name');
$filterDto = $filter->getAsDto();
$adminContext = $this->createAdminContext();

$this->assertTrue($configurator->supports($filterDto, null, $this->entityDto, $adminContext));
}

public function testConfigureUsesFieldLabelWhenAvailable(): void
{
$configurator = $this->createConfigurator();
$filter = TextFilter::new('name');
$filterDto = $filter->getAsDto();

$field = TextField::new('name', 'Product Name');
$fieldDto = $field->getAsDto();

$adminContext = $this->createAdminContext();

$configurator->configure($filterDto, $fieldDto, $this->entityDto, $adminContext);

$this->assertSame('Product Name', $filterDto->getLabel());
}

public function testConfigureUsesFieldTranslatableMessageLabel(): void
{
$configurator = $this->createConfigurator();
$filter = TextFilter::new('name');
$filterDto = $filter->getAsDto();

$field = TextField::new('name');
$fieldDto = $field->getAsDto();
$fieldDto->setLabel(new TranslatableMessage('product.name'));

$adminContext = $this->createAdminContext();

$configurator->configure($filterDto, $fieldDto, $this->entityDto, $adminContext);

$this->assertSame('product.name', $filterDto->getLabel());
}

public function testConfigureHumanizesLabelWhenFieldIsNullAndEntityTranslationsDisabled(): void
{
$configurator = $this->createConfigurator();
$filter = TextFilter::new('productName');
$filterDto = $filter->getAsDto();

$adminContext = $this->createAdminContext(useEntityTranslations: false);

$configurator->configure($filterDto, null, $this->entityDto, $adminContext);

$this->assertSame('Product Name', $filterDto->getLabel());
}

public function testConfigureUsesEntityTranslationWhenFieldIsNullAndEntityTranslationsEnabled(): void
{
$expectedTranslationId = 'entities.App\\Entity\\Product.properties.productName';

$generator = $this->createMock(EntityTranslationIdGeneratorInterface::class);
$generator->expects($this->once())
->method('generateForProperty')
->with('App\Entity\Product', 'productName')
->willReturn($expectedTranslationId);

$configurator = new CommonConfigurator($generator);
$filter = TextFilter::new('productName');
$filterDto = $filter->getAsDto();

$adminContext = $this->createAdminContext(useEntityTranslations: true);

$configurator->configure($filterDto, null, $this->entityDto, $adminContext);

$this->assertSame($expectedTranslationId, $filterDto->getLabel());
}

public function testConfigureDoesNotOverrideExplicitFilterLabel(): void
{
$configurator = $this->createConfigurator();
$filter = TextFilter::new('name')->setLabel('Custom Label');
$filterDto = $filter->getAsDto();

$adminContext = $this->createAdminContext();

$configurator->configure($filterDto, null, $this->entityDto, $adminContext);

$this->assertSame('Custom Label', $filterDto->getLabel());
}

private function createConfigurator(): CommonConfigurator
{
$generator = $this->createMock(EntityTranslationIdGeneratorInterface::class);

return new CommonConfigurator($generator);
}

private function createAdminContext(bool $useEntityTranslations = false): AdminContext
{
$dashboardDto = Dashboard::new()->getAsDto();
if ($useEntityTranslations) {
$dashboardDto->setUseEntityTranslations(true);
}

return AdminContext::forTesting(
RequestContext::forTesting(new Request()),
null,
DashboardContext::forTesting($dashboardDto),
I18nContext::forTesting('en', 'ltr')
);
}
}
Loading