Merge pull request #186 from symfony-cmf/issue_130

Deprecate TranslatableExtension in favor of SonataTranslationBundle

Author: dbu

Admin/Extension/TranslatableExtension.php

@@ -21,6 +21,8 @@
  * Admin extension to add publish workflow time period fields.
  *
  * @author David Buchmann <[email protected]>
+ *
+ * @deprecated Since version 1.3, to be removed in 2.0. Use the SonataTranslationBundle instead.
  */
 class TranslatableExtension extends AdminExtension
 {
@@ -40,6 +42,8 @@ class TranslatableExtension extends AdminExtension
      */
     public function __construct($locales, $formGroup = 'form.group_general')
     {
+        @trigger_error('The '.__CLASS__.' class is deprecated since version 1.3 and will be removed in 2.0. Use the SonataTranslationBundle instead.', E_USER_DEPRECATED);
+
         $this->locales = $locales;
         $this->formGroup = $formGroup;
     }

CHANGELOG.md

@@ -1,6 +1,7 @@
 Changelog
 =========
 
+* **2016-01-24**: The `TranslatableExtension` and `cmf_core.admin_extension.translatable` services are deprecated in favor of the SonataTranslationBundle
 * **2015-04-12**: [BC BREAK] The following services were made private: `cmf_core.admin_extension.child`, `cmf_core.security.publishable_voter`, `cmf_core.security.publish_time_period_voter`, `cmf_core.security.published_voter`, `cmf_core.admin_extension.publish_workflow.publishable`, `cmf_core.admin_extension.publish_workflow.time_period`, `cmf_core.twig.children_extension`, `cmf_core.templating.helper`, `cmf_core.persistence.phpcr.non_translatable_metadata_listener`, `cmf_core.persistence.phpcr.translatable_metadata_listener`, `cmf_core.admin_extension.translatable`
 * **2015-04-12**: The following services could not be private, but should be considered as such: `cmf_core.publish_workflow.request_listener`, `cmf_core.form.type.checkbox_url_label`
 

DependencyInjection/CmfCoreExtension.php

@@ -37,11 +37,10 @@ public function prepend(ContainerBuilder $container)
         $config = $this->processConfiguration(new Configuration(), $configs);
 
         $extensions = $container->getExtensions();
-        if (isset($config['multilang']['locales'])) {
-            $prependConfig = array('multilang' => $config['multilang']);
-            if (isset($extensions['cmf_routing'])) {
-                $container->prependExtensionConfig('cmf_routing', array('dynamic' => $prependConfig['multilang']));
-            }
+        if (isset($config['multilang']['locales']) && isset($extensions['cmf_routing'])) {
+            $container->prependExtensionConfig('cmf_routing', array(
+                'dynamic' => array('locales' => $config['multilang']['locales']),
+            ));
         }
 
         if ($config['persistence']['phpcr']) {
@@ -63,6 +62,7 @@ public function prepend(ContainerBuilder $container)
                                 ),
                             ),
                         );
+
                         break;
                     case 'cmf_content':
                         $prependConfig = array(
@@ -74,6 +74,7 @@ public function prepend(ContainerBuilder $container)
                                 ),
                             ),
                         );
+
                         break;
                     case 'cmf_create':
                         $prependConfig = array(
@@ -91,6 +92,7 @@ public function prepend(ContainerBuilder $container)
                                 'basepath' => $persistenceConfig['basepath'].'/media',
                             );
                         }
+
                         break;
                     case 'cmf_media':
                         $prependConfig = array(
@@ -102,6 +104,7 @@ public function prepend(ContainerBuilder $container)
                                 ),
                             ),
                         );
+
                         break;
                     case 'cmf_menu':
                         $prependConfig = array(
@@ -115,6 +118,7 @@ public function prepend(ContainerBuilder $container)
                                 ),
                             ),
                         );
+
                         break;
                     case 'cmf_routing':
                         $routePaths = array($persistenceConfig['basepath'].'/routes');
@@ -136,6 +140,7 @@ public function prepend(ContainerBuilder $container)
                         if (isset($bundles['CmfContentBundle'])) {
                             $prependConfig['dynamic']['generic_controller'] = 'cmf_content.controller:indexAction';
                         }
+
                         break;
                     case 'cmf_routing_auto':
                         $prependConfig = array(
@@ -146,6 +151,7 @@ public function prepend(ContainerBuilder $container)
                                 ),
                             ),
                         );
+
                         break;
                     case 'cmf_search':
                         $prependConfig = array(
@@ -161,6 +167,7 @@ public function prepend(ContainerBuilder $container)
                         if (!empty($persistenceConfig['translation_strategy'])) {
                             $prependConfig['persistence']['phpcr']['translation_strategy'] = $persistenceConfig['translation_strategy'];
                         }
+
                         break;
                     case 'cmf_simple_cms':
                         $prependConfig = array(
@@ -174,6 +181,7 @@ public function prepend(ContainerBuilder $container)
                                 ),
                             ),
                         );
+
                         break;
                     case 'cmf_tree_browser':
                         $prependConfig = array(
@@ -183,6 +191,7 @@ public function prepend(ContainerBuilder $container)
                                 ),
                             ),
                         );
+
                         break;
                     case 'cmf_seo':
                         $prependConfig = array(
@@ -195,6 +204,7 @@ public function prepend(ContainerBuilder $container)
                                 'enabled' => $persistenceConfig['use_sonata_admin'],
                             ),
                         );
+
                         break;
                 }
 

Tests/Unit/Admin/Extension/TranslatableExtensionTest.php

@@ -13,6 +13,9 @@
 
 use Symfony\Cmf\Bundle\CoreBundle\Admin\Extension\TranslatableExtension;
 
+/**
+ * @group legacy
+ */
 class TranslatableExtensionTest extends \PHPUnit_Framework_TestCase
 {
     public function setUp()

composer.json

@@ -30,7 +30,8 @@
         "symfony/security-bundle": "To be able to use the publish workflow system (^2.1)",
         "symfony-cmf/routing": "To be able to use the CMF twig extension functions cmf_prev_linkable/cmf_next_linkable (^1.2)",
         "symfony-cmf/routing-bundle": "To be able to enable the publish_workflow_listener (^1.2)",
-        "sonata-project/admin-bundle": "To be able to enable the publish_workflow_listener extension (^2.2)"
+        "sonata-project/admin-bundle": "To be able to enable the publish_workflow_listener extension (^2.2)",
+        "sonata-project/translation-bundle": "To be able to edit translatable documents (^1.0)"
     },
     "autoload": {
         "psr-4": {