Skip to content

[Translatable] Add methods to remove translations by entity, by field or by locale #3030

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

Open
kevinkopf wants to merge 1 commit into
base: main
Choose a base branch
from
+178 −0
Open

[Translatable] Add methods to remove translations by entity, by field or by locale #3030

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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ coverage.xml
phpstan.neon
.phpunit.result.cache
phpunit.xml
.idea
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ a release.
## [Unreleased]
### Changed
- All: Removed the dollar sign from the generated cache ID for extension metadata to ensure only characters mandated by [PSR-6](https://www.php-fig.org/psr/psr-6/#definitions) are used, improving compatibility with caching implementations with strict character requirements (#2978)
- Translatable: Introduce a method to remove translations for a specific entity. Either all at once, or by field and/or locale.

## [3.22.0] - 2025-12-13
### Added
Expand Down
38 changes: 38 additions & 0 deletions src/Translatable/Entity/Repository/TranslationRepository.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,44 @@ public function findTranslationsByObjectId($id)
return $result;
}

public function removeTranslations($entity, $field = null, $locale = null)
{
$wrapped = new EntityWrapper($entity, $this->getEntityManager());
if ($wrapped->hasValidIdentifier()) {
$entityId = $wrapped->getIdentifier();
$config = $this
->getTranslatableListener()
->getConfiguration($this->getEntityManager(), $wrapped->getMetadata()->getName());

if (!$config) {
return;
}

$entityClass = $config['useObjectClass'];
$translationMeta = $this->getClassMetadata(); // table inheritance support

$translationClass = $config['translationClass'] ?? $translationMeta->rootEntityName;

$qb = $this->getEntityManager()->createQueryBuilder();
$qb->delete()
->from($translationClass, 'trans')
->where('trans.foreignKey = :entityId', 'trans.objectClass = :entityClass')
->setParameter('entityId', $entityId)
->setParameter('entityClass', $entityClass);

if ($field) {
$qb->andWhere('trans.field = :field')
->setParameter('field', $field);
}
if ($locale) {
$qb->andWhere('trans.locale = :locale')
->setParameter('locale', $locale);
}

$qb->getQuery()->execute();
}
}

/**
* Get the currently used TranslatableListener
*
Expand Down
138 changes: 138 additions & 0 deletions tests/Gedmo/Translatable/TranslatableEntityCollectionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,144 @@ public function testShouldUpdateMultipleTranslations(): void
static::assertSame('content lt', $translations['lt_lt']['content']);
}

public function testShouldRemoveAllTranslations(): void
{
$this->populate();
$repo = $this->em->getRepository(Translation::class);
$sport = $this->em->getRepository(Article::class)->find(1);
$repo
->translate($sport, 'title', 'lt_lt', 'sport lt')
->translate($sport, 'content', 'lt_lt', 'content lt')
->translate($sport, 'title', 'ru_ru', 'sport ru change')
->translate($sport, 'content', 'ru_ru', 'content ru change')
->translate($sport, 'title', 'en_us', 'sport en update')
->translate($sport, 'content', 'en_us', 'content en update')
;
$this->em->flush();
$repo->removeTranslations($sport);

$translations = $repo->findTranslations($sport);
static::assertCount(0, $translations);
}

public function testShouldRemoveTitleTranslations(): void
{
$this->populate();
$repo = $this->em->getRepository(Translation::class);
$sport = $this->em->getRepository(Article::class)->find(1);
$repo
->translate($sport, 'title', 'lt_lt', 'sport lt')
->translate($sport, 'content', 'lt_lt', 'content lt')
->translate($sport, 'title', 'ru_ru', 'sport ru change')
->translate($sport, 'content', 'ru_ru', 'content ru change')
->translate($sport, 'title', 'en_us', 'sport en update')
->translate($sport, 'content', 'en_us', 'content en update')
;
$this->em->flush();
$repo->removeTranslations($sport, 'title');

$translations = $repo->findTranslations($sport);
static::assertCount(3, $translations);

static::assertArrayHasKey('de_de', $translations);
static::assertArrayNotHasKey('title', $translations['de_de']);
static::assertArrayHasKey('content', $translations['de_de']);
static::assertSame('sport de', $translations['de_de']['title']);
static::assertSame('content de', $translations['de_de']['content']);

static::assertArrayHasKey('ru_ru', $translations);
static::assertArrayNotHasKey('title', $translations['ru_ru']);
static::assertArrayHasKey('content', $translations['ru_ru']);
static::assertSame('sport ru change', $translations['ru_ru']['title']);
static::assertSame('content ru change', $translations['ru_ru']['content']);

static::assertArrayHasKey('lt_lt', $translations);
static::assertArrayNotHasKey('title', $translations['lt_lt']);
static::assertArrayHasKey('content', $translations['lt_lt']);
static::assertSame('sport lt', $translations['lt_lt']['title']);
static::assertSame('content lt', $translations['lt_lt']['content']);
}

public function testShouldRemoveLocaleTranslations(): void
{
$this->populate();
$repo = $this->em->getRepository(Translation::class);
$sport = $this->em->getRepository(Article::class)->find(1);
$repo
->translate($sport, 'title', 'lt_lt', 'sport lt')
->translate($sport, 'content', 'lt_lt', 'content lt')
->translate($sport, 'title', 'ru_ru', 'sport ru change')
->translate($sport, 'content', 'ru_ru', 'content ru change')
->translate($sport, 'title', 'en_us', 'sport en update')
->translate($sport, 'content', 'en_us', 'content en update')
;
$this->em->flush();

$translations = $repo->findTranslations($sport);
static::assertCount(3, $translations);

$repo->removeTranslations($sport, null, 'lt_lt');

$translations = $repo->findTranslations($sport);
static::assertCount(2, $translations);

static::assertArrayHasKey('de_de', $translations);
static::assertArrayNotHasKey('title', $translations['de_de']);
static::assertArrayHasKey('content', $translations['de_de']);
static::assertSame('sport de', $translations['de_de']['title']);
static::assertSame('content de', $translations['de_de']['content']);

static::assertArrayHasKey('ru_ru', $translations);
static::assertArrayNotHasKey('title', $translations['ru_ru']);
static::assertArrayHasKey('content', $translations['ru_ru']);
static::assertSame('sport ru change', $translations['ru_ru']['title']);
static::assertSame('content ru change', $translations['ru_ru']['content']);

static::assertArrayNotHasKey('lt_lt', $translations);
}

public function testShouldRemoveFieldAndLocaleTranslations(): void
{
$this->populate();
$repo = $this->em->getRepository(Translation::class);
$sport = $this->em->getRepository(Article::class)->find(1);
$repo
->translate($sport, 'title', 'lt_lt', 'sport lt')
->translate($sport, 'content', 'lt_lt', 'content lt')
->translate($sport, 'title', 'ru_ru', 'sport ru change')
->translate($sport, 'content', 'ru_ru', 'content ru change')
->translate($sport, 'title', 'en_us', 'sport en update')
->translate($sport, 'content', 'en_us', 'content en update')
;
$this->em->flush();

$translations = $repo->findTranslations($sport);
static::assertCount(3, $translations);

$repo->removeTranslations($sport, 'title', 'lt_lt');

$translations = $repo->findTranslations($sport);
static::assertCount(3, $translations);

static::assertArrayHasKey('de_de', $translations);
static::assertArrayHasKey('title', $translations['de_de']);
static::assertArrayHasKey('content', $translations['de_de']);
static::assertSame('sport de', $translations['de_de']['title']);
static::assertSame('content de', $translations['de_de']['content']);

static::assertArrayHasKey('ru_ru', $translations);
static::assertArrayHasKey('title', $translations['ru_ru']);
static::assertArrayHasKey('content', $translations['ru_ru']);
static::assertSame('sport ru change', $translations['ru_ru']['title']);
static::assertSame('content ru change', $translations['ru_ru']['content']);

static::assertArrayHasKey('lt_lt', $translations);
static::assertArrayNotHasKey('title', $translations['lt_lt']);
static::assertArrayHasKey('content', $translations['lt_lt']);
static::assertSame('sport lt', $translations['lt_lt']['title']);
static::assertSame('content lt', $translations['lt_lt']['content']);
}

protected function getUsedEntityFixtures(): array
{
return [
Expand Down