Merge pull request #347 from OskarStark/deprecations

better deprecation handling for BasePickerType
sonata-project · Sep 27, 2016 · 1b12f54 · 1b12f54
2 parents 589f043 + 823950f
commit 1b12f54
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 7 deletions.
diff --git a/Form/Type/BasePickerType.php b/Form/Type/BasePickerType.php
@@ -21,7 +21,6 @@
 /**
  * Class BasePickerType (to factorize DatePickerType and DateTimePickerType code.
  *
- *
  * @author Hugo Briand <briand@ekino.com>
  */
 abstract class BasePickerType extends AbstractType
@@ -35,12 +34,15 @@ abstract class BasePickerType extends AbstractType
      * @var string
      */
     protected $locale;
+
     /**
      * @var MomentFormatConverter
      */
     private $formatConverter;
 
     /**
+     * NEXT_MAJOR: TranslatorInterface needs to be mandatory.
+     *
      * @param MomentFormatConverter $formatConverter
      * @param TranslatorInterface   $translator
      */
@@ -49,12 +51,21 @@ public function __construct(MomentFormatConverter $formatConverter, TranslatorIn
         $this->formatConverter = $formatConverter;
         $this->translator = $translator;
 
-        if (null !== $this->translator) {
-            $this->locale = $this->translator->getLocale();
-        } else {
-            @trigger_error('Initializing '.__CLASS__.' without TranslatorInterface is deprecated since 3.0 and will be removed in 4.0.', E_USER_DEPRECATED);
+        /*
+         * NEXT_MAJOR: remove this check
+         */
+        if (null === $this->translator) {
+            @trigger_error(
+                'Initializing '.__CLASS__.' without TranslatorInterface
+                is deprecated since 2.4 and will be removed in 4.0.',
+                E_USER_DEPRECATED
+            );
             $this->locale = \Locale::getDefault();
+
+            return;
         }
+
+        $this->locale = $this->translator->getLocale();
     }
 
     /**
@@ -68,7 +79,14 @@ public function finishView(FormView $view, FormInterface $form, array $options)
             $format = $options['date_format'];
         } elseif (is_int($format)) {
             $timeFormat = ($options['dp_pick_time']) ? DateTimeType::DEFAULT_TIME_FORMAT : \IntlDateFormatter::NONE;
-            $intlDateFormatter = new \IntlDateFormatter(\Locale::getDefault(), $format, $timeFormat, null, \IntlDateFormatter::GREGORIAN, null);
+            $intlDateFormatter = new \IntlDateFormatter(
+                \Locale::getDefault(),
+                $format,
+                $timeFormat,
+                null,
+                \IntlDateFormatter::GREGORIAN,
+                null
+            );
             $format = $intlDateFormatter->getPattern();
         }
 

diff --git a/Tests/Form/Type/BasePickerTypeTest.php b/Tests/Form/Type/BasePickerTypeTest.php
@@ -31,13 +31,18 @@ protected function getDefaultFormat()
 }
 
 /**
+ * Class BasePickerTypeTest.
+ *
  * @author Hugo Briand <briand@ekino.com>
  */
 class BasePickerTypeTest extends \PHPUnit_Framework_TestCase
 {
     public function testFinishView()
     {
-        $type = new BasePickerTest(new MomentFormatConverter(), $this->getMock('Symfony\Component\Translation\TranslatorInterface'));
+        $type = new BasePickerTest(
+            new MomentFormatConverter(),
+            $this->getMock('Symfony\Component\Translation\TranslatorInterface')
+        );
 
         $view = new FormView();
         $form = new Form($this->getMock('Symfony\Component\Form\FormConfigInterface'));
@@ -56,6 +61,11 @@ public function testFinishView()
         $this->assertSame('text', $view->vars['type']);
     }
 
+    /**
+     * NEXT_MAJOR: remove this test.
+     *
+     * @group legacy
+     */
     public function testLegacyConstructor()
     {
         new BasePickerTest(new MomentFormatConverter());

diff --git a/UPGRADE-3.x.md b/UPGRADE-3.x.md
@@ -13,3 +13,24 @@ The exporter class and service are now deprecated in favor of very similar equiv
 [`sonata-project/exporter`](https://github.com/sonata-project/exporter) library,
 which are available since version 1.6.0,
 if you enable the bundle as described in the documentation.
+
+### BasePickerType needs a ``TranslatorInterface`` as 2nd argument
+
+Before:
+
+```php
+    /**
+     * @param MomentFormatConverter $formatConverter
+     */
+    public function __construct(MomentFormatConverter $formatConverter)
+```
+
+After:
+
+```php
+    /**
+     * @param MomentFormatConverter $formatConverter
+     * @param TranslatorInterface   $translator
+     */
+    public function __construct(MomentFormatConverter $formatConverter, TranslatorInterface $translator)
+```