2.9.0

CHANGELOG.md

@@ -2,6 +2,24 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.9.0](https://github.com/sonata-project/SonataTranslationBundle/compare/2.8.1...2.9.0) - 2021-09-21
+### Added
+- [[#543](https://github.com/sonata-project/SonataTranslationBundle/pull/543)] Added `LocaleProviderInterface` and `RequestLocaleProvider` to get the locale based on the parameter from the URL or the default configured one ([@franmomu](https://github.com/franmomu))
+- [[#543](https://github.com/sonata-project/SonataTranslationBundle/pull/543)] Added `LocaleProvider` service when `knplabs` is enabled to be able to show the content in the proper language ([@franmomu](https://github.com/franmomu))
+
+### Deprecated
+- [[#542](https://github.com/sonata-project/SonataTranslationBundle/pull/542)] Deprecated implementing `Sonata\TranslationBundle\Model\TranslatableInterface` in an Entity implementing `Knp\DoctrineBehaviors\Contract\Entity\TranslatableInterface` ([@franmomu](https://github.com/franmomu))
+- [[#537](https://github.com/sonata-project/SonataTranslationBundle/pull/537)] `Sonata\TranslationBundle\Model\Gedmo\AbstractPersonalTranslatable` class ([@franmomu](https://github.com/franmomu))
+- [[#537](https://github.com/sonata-project/SonataTranslationBundle/pull/537)] `Sonata\TranslationBundle\Model\Gedmo\AbstractPersonalTranslation` class ([@franmomu](https://github.com/franmomu))
+- [[#537](https://github.com/sonata-project/SonataTranslationBundle/pull/537)] `Sonata\TranslationBundle\Model\Gedmo\AbstractTranslatable` class ([@franmomu](https://github.com/franmomu))
+- [[#537](https://github.com/sonata-project/SonataTranslationBundle/pull/537)] `Sonata\TranslationBundle\Model\AbstractTranslatable` class ([@franmomu](https://github.com/franmomu))
+- [[#537](https://github.com/sonata-project/SonataTranslationBundle/pull/537)] `Sonata\TranslationBundle\Traits\Gedmo\PersonalTranslatableTrait` trait ([@franmomu](https://github.com/franmomu))
+- [[#537](https://github.com/sonata-project/SonataTranslationBundle/pull/537)] `Sonata\TranslationBundle\Traits\Gedmo\TranslatableTrait` trait ([@franmomu](https://github.com/franmomu))
+- [[#537](https://github.com/sonata-project/SonataTranslationBundle/pull/537)] `Sonata\TranslationBundle\Traits\TranslatableTrait` trait ([@franmomu](https://github.com/franmomu))
+
+### Removed
+- [[#542](https://github.com/sonata-project/SonataTranslationBundle/pull/542)] Removed support of `knplabs/doctrine-behaviors` < 2.2 ([@franmomu](https://github.com/franmomu))
+
 ## [2.8.1](https://github.com/sonata-project/SonataTranslationBundle/compare/2.8.0...2.8.1) - 2021-05-18
 ### Fixed
 - [[#491](https://github.com/sonata-project/SonataTranslationBundle/pull/491)] Fixed registering `sonata_translation.listener.translatable` when no `translatable_listener_service` is defined ([@franmomu](https://github.com/franmomu))

UPGRADE-2.x.md

@@ -1,31 +1,9 @@
 UPGRADE 2.x
 ===========
 
-UPGRADE FROM 2.x to 2.x
+UPGRADE FROM 2.8 to 2.9
 =======================
 
-If you are using this bundle with "gedmo/doctrine-extensions", you MUST to specify the translatable listener service
-name in the configuration.
-
-Before:
-```yaml
-# config/packages/sonata_translation.yaml
-
-sonata_translation:
-    gedmo:
-      enabled: true
-```
-After:
-```yaml
-# config/packages/sonata_translation.yaml
-
-sonata_translation:
-    gedmo:
-        enabled: true
-        # in case you are using stof/doctrine-extensions-bundle
-        translatable_listener_service: stof_doctrine_extensions.listener.translatable
-```
-
 ### Deprecated abstract models and traits
 
 - `Sonata\TranslationBundle\Model\Gedmo\AbstractPersonalTranslatable`.
@@ -50,6 +28,31 @@ It is deprecated implementing `Sonata\TranslationBundle\Model\TranslatableInterf
 `Sonata\TranslationBundle\Admin\Extension\Phpcr\TranslatableAdminExtension` classes must receive an instance of
 `LocaleProviderInterface` as second argument.
 
+UPGRADE FROM 2.7 to 2.8
+=======================
+
+If you are using this bundle with "gedmo/doctrine-extensions", you MUST to specify the translatable listener service
+name in the configuration.
+
+Before:
+```yaml
+# config/packages/sonata_translation.yaml
+
+sonata_translation:
+    gedmo:
+      enabled: true
+```
+After:
+```yaml
+# config/packages/sonata_translation.yaml
+
+sonata_translation:
+    gedmo:
+        enabled: true
+        # in case you are using stof/doctrine-extensions-bundle
+        translatable_listener_service: stof_doctrine_extensions.listener.translatable
+```
+
 UPGRADE FROM 2.1 to 2.7
 =======================
 

src/Admin/Extension/AbstractTranslatableAdminExtension.php

@@ -60,7 +60,7 @@ public function __construct(TranslatableChecker $translatableChecker, $defaultTr
         if (!$defaultTranslationLocaleOrLocaleProvider instanceof LocaleProviderInterface) {
             @trigger_error(sprintf(
                 'Omitting the argument 2 or passing other type than "%s" to "%s()" is deprecated'
-                .' since sonata-project/translation-bundle 2.x and will be not possible in version 3.0.',
+                .' since sonata-project/translation-bundle 2.9 and will be not possible in version 3.0.',
                 LocaleProviderInterface::class,
                 __METHOD__
             ), \E_USER_DEPRECATED);

src/Admin/Extension/Knplabs/TranslatableAdminExtension.php

@@ -31,7 +31,7 @@ public function alterNewInstance(AdminInterface $admin, $object)
             if ($object instanceof TranslatableInterface) {
                 @trigger_error(sprintf(
                     'Implementing "%1$s" for entities using "knplabs/doctrine-behaviors" is deprecated'
-                    .' since sonata-project/translation-bundle 2.x and "%1$s::setLocale()" method will not be called'
+                    .' since sonata-project/translation-bundle 2.9 and "%1$s::setLocale()" method will not be called'
                     .' anymore in version 3.0.',
                     TranslatableInterface::class
                 ), \E_USER_DEPRECATED);
@@ -52,7 +52,7 @@ public function alterObject(AdminInterface $admin, $object)
             if ($object instanceof TranslatableInterface) {
                 @trigger_error(sprintf(
                     'Implementing "%1$s" for entities using "knplabs/doctrine-behaviors" 3 is deprecated'
-                    .' since sonata-project/translation-bundle 2.x and "%1$s::setLocale()" method will not be called'
+                    .' since sonata-project/translation-bundle 2.9 and "%1$s::setLocale()" method will not be called'
                     .' anymore in version 3.0.',
                     TranslatableInterface::class
                 ), \E_USER_DEPRECATED);

src/Checker/TranslatableChecker.php

@@ -122,7 +122,7 @@ public function isTranslatable($object)
         if (\count(array_intersect($translateTraits, $traits)) > 0) {
             @trigger_error(sprintf(
                 'Using traits to specify that a model is translatable is deprecated since'
-                .' sonata-project/translation-bundle 2.x and will be not possible in version 3.0. To mark "%s" class'
+                .' sonata-project/translation-bundle 2.9 and will be not possible in version 3.0. To mark "%s" class'
                 .' as translatable you should implement one of "%s" interfaces.',
                 \is_string($object) ? $object : \get_class($object),
                 implode(', ', $this->getSupportedInterfaces())

src/DependencyInjection/Configuration.php

@@ -68,7 +68,7 @@ public function getConfigTreeBuilder()
                             ->defaultValue(static function (): string {
                                 @trigger_error(
                                     'Not specifying the translatable listener service when using'
-                                    .' gedmo/doctrine-extensions is deprecated since sonata-project/translation-bundle 2.x.'
+                                    .' gedmo/doctrine-extensions is deprecated since sonata-project/translation-bundle 2.8.'
                                     .' If you are using a bundle that integrates this library, it is likely that it'
                                     .' registers that service for you. In case of "stof/doctrine-extensions-bundle", it is:'
                                     .' "stof_doctrine_extensions.listener.translatable".'

src/Model/AbstractTranslatable.php

@@ -20,7 +20,7 @@
  *
  * @author Nicolas Bastien <nbastien.pro@gmail.com>
  *
- * @deprecated since version 2.x, to be removed in 3.0.
+ * @deprecated since version 2.9, to be removed in 3.0.
  */
 abstract class AbstractTranslatable
 {

src/Model/Gedmo/AbstractPersonalTranslatable.php

@@ -24,7 +24,7 @@
  *
  * @author Nicolas Bastien <nbastien.pro@gmail.com>
  *
- * @deprecated since version 2.x, to be removed in 3.0. Create your own instead.
+ * @deprecated since version 2.9, to be removed in 3.0. Create your own instead.
  * @see https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/translatable.md : Personal translations
  */
 abstract class AbstractPersonalTranslatable extends AbstractTranslatable

src/Model/Gedmo/AbstractPersonalTranslation.php

@@ -20,7 +20,7 @@
  *
  * @author Nicolas Bastien <nbastien.pro@gmail.com>
  *
- * @deprecated since version 2.x, to be removed in 3.0. Create your own instead.
+ * @deprecated since version 2.9, to be removed in 3.0. Create your own instead.
  * @see https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/translatable.md : Personal translations
  */
 class AbstractPersonalTranslation extends GedmoAbstractPersonalTranslation

src/Model/Gedmo/AbstractTranslatable.php

@@ -24,7 +24,7 @@
  *
  * @author Nicolas Bastien <nbastien.pro@gmail.com>
  *
- * @deprecated since version 2.x, to be removed in 3.0. Create your own instead.
+ * @deprecated since version 2.9, to be removed in 3.0. Create your own instead.
  * @see https://github.com/l3pp4rd/DoctrineExtensions/blob/master/doc/translatable.md
  */
 abstract class AbstractTranslatable extends \Sonata\TranslationBundle\Model\AbstractTranslatable

src/Traits/Gedmo/PersonalTranslatableTrait.php

@@ -21,7 +21,7 @@
  *
  * If you don't want to use trait, you can extend AbstractPersonalTranslatable instead.
  *
- * @deprecated since version 2.x, to be removed in 3.0. Create your own trait instead.
+ * @deprecated since version 2.9, to be removed in 3.0. Create your own trait instead.
  *
  * @author Nicolas Bastien <nbastien.pro@gmail.com>
  */

src/Traits/Gedmo/TranslatableTrait.php

@@ -18,7 +18,7 @@
  *
  * If you don't want to use trait, you can extend AbstractTranslatable instead.
  *
- * @deprecated since version 2.x, to be removed in 3.0. Create your own trait instead.
+ * @deprecated since version 2.9, to be removed in 3.0. Create your own trait instead.
  *
  * @author Nicolas Bastien <nbastien.pro@gmail.com>
  */

src/Traits/TranslatableTrait.php

@@ -20,7 +20,7 @@
  *
  * @author Nicolas Bastien <nbastien.pro@gmail.com>
  *
- * @deprecated since version 2.x and will be removed in 3.0.
+ * @deprecated since version 2.9 and will be removed in 3.0.
  */
 trait TranslatableTrait
 {

tests/Admin/Extension/AbstractTranslatableAdminExtensionTest.php

@@ -105,7 +105,7 @@ public function testGetTranslatableLocaleFromContainer(): void
             ->method('getConfigurationPool')
             ->willReturn($pool);
 
-        $this->expectDeprecation('Omitting the argument 2 or passing other type than "Sonata\TranslationBundle\Provider\LocaleProviderInterface" to "Sonata\TranslationBundle\Admin\Extension\AbstractTranslatableAdminExtension::__construct()" is deprecated since sonata-project/translation-bundle 2.x and will be not possible in version 3.0.');
+        $this->expectDeprecation('Omitting the argument 2 or passing other type than "Sonata\TranslationBundle\Provider\LocaleProviderInterface" to "Sonata\TranslationBundle\Admin\Extension\AbstractTranslatableAdminExtension::__construct()" is deprecated since sonata-project/translation-bundle 2.9 and will be not possible in version 3.0.');
 
         $extension = new class($this->translatableChecker) extends AbstractTranslatableAdminExtension {
         };

tests/Admin/Extension/Gedmo/DeprecatedTranslatableAdminExtensionTest.php

@@ -65,7 +65,7 @@ protected function setUp(): void
             TranslatableInterface::class,
         ]);
 
-        $this->expectDeprecation('Omitting the argument 2 or passing other type than "Sonata\TranslationBundle\Provider\LocaleProviderInterface" to "Sonata\TranslationBundle\Admin\Extension\AbstractTranslatableAdminExtension::__construct()" is deprecated since sonata-project/translation-bundle 2.x and will be not possible in version 3.0.');
+        $this->expectDeprecation('Omitting the argument 2 or passing other type than "Sonata\TranslationBundle\Provider\LocaleProviderInterface" to "Sonata\TranslationBundle\Admin\Extension\AbstractTranslatableAdminExtension::__construct()" is deprecated since sonata-project/translation-bundle 2.9 and will be not possible in version 3.0.');
         $this->expectDeprecation('Not passing an instance of "Gedmo\Translatable\TranslatableListener" as argument 2 to "Sonata\TranslationBundle\Admin\Extension\Gedmo\TranslatableAdminExtension::__construct()" is deprecated since sonata-project/translation-bundle 2.7 and will be mandatory in 3.0.');
         $this->expectDeprecation('Not passing an instance of "Doctrine\Persistence\ManagerRegistry" as argument 3 to "Sonata\TranslationBundle\Admin\Extension\Gedmo\TranslatableAdminExtension::__construct()" is deprecated since sonata-project/translation-bundle 2.7 and will be mandatory in 3.0.');
 

tests/Admin/Extension/Knplabs/TranslatableAdminExtensionTest.php

@@ -94,7 +94,7 @@ public function testDeprecatedSetLocaleForTranslatableObject(): void
     {
         $object = new DeprecatedTranslatableEntity();
 
-        $this->expectDeprecation('Implementing "Sonata\TranslationBundle\Model\TranslatableInterface" for entities using "knplabs/doctrine-behaviors" is deprecated since sonata-project/translation-bundle 2.x and "Sonata\TranslationBundle\Model\TranslatableInterface::setLocale()" method will not be called anymore in version 3.0.');
+        $this->expectDeprecation('Implementing "Sonata\TranslationBundle\Model\TranslatableInterface" for entities using "knplabs/doctrine-behaviors" is deprecated since sonata-project/translation-bundle 2.9 and "Sonata\TranslationBundle\Model\TranslatableInterface::setLocale()" method will not be called anymore in version 3.0.');
 
         $this->extension->alterNewInstance($this->admin, $object);
 

tests/Checker/TranslatableCheckerTest.php

@@ -71,7 +71,7 @@ public function testIsTranslatableOnTrait(): void
 
         $object = new ModelUsingTraitTranslatable();
 
-        $this->expectDeprecation('Using traits to specify that a model is translatable is deprecated since sonata-project/translation-bundle 2.x and will be not possible in version 3.0. To mark "Sonata\TranslationBundle\Tests\Fixtures\Model\ModelUsingTraitTranslatable" class as translatable you should implement one of "Gedmo\Translatable\Translatable" interfaces.');
+        $this->expectDeprecation('Using traits to specify that a model is translatable is deprecated since sonata-project/translation-bundle 2.9 and will be not possible in version 3.0. To mark "Sonata\TranslationBundle\Tests\Fixtures\Model\ModelUsingTraitTranslatable" class as translatable you should implement one of "Gedmo\Translatable\Translatable" interfaces.');
 
         static::assertTrue($translatableChecker->isTranslatable($object));
     }