Add return types to tests and final|internal|private methods

nicolas-grekas · nicolas-grekas · commit 9e4b8be8ae0e · 2019-08-21T17:14:41.000+02:00
diff --git a/Intl.php b/Intl.php
@@ -109,7 +109,7 @@ final class Intl
      *
      * @return bool Returns true if the intl extension is installed, false otherwise
      */
-    public static function isExtensionLoaded()
+    public static function isExtensionLoaded(): bool
     {
         return class_exists('\ResourceBundle');
     }
@@ -121,7 +121,7 @@ public static function isExtensionLoaded()
      *
      * @deprecated since Symfony 4.3, to be removed in 5.0. Use {@see Currencies} instead.
      */
-    public static function getCurrencyBundle()
+    public static function getCurrencyBundle(): CurrencyBundleInterface
     {
         @trigger_error(sprintf('The method "%s()" is deprecated since Symfony 4.3, use "%s" instead.', __METHOD__, Currencies::class), E_USER_DEPRECATED);
 
@@ -143,7 +143,7 @@ public static function getCurrencyBundle()
      *
      * @deprecated since Symfony 4.3, to be removed in 5.0. Use {@see Languages} or {@see Scripts} instead.
      */
-    public static function getLanguageBundle()
+    public static function getLanguageBundle(): LanguageBundleInterface
     {
         @trigger_error(sprintf('The method "%s()" is deprecated since Symfony 4.3, use "%s" or "%s" instead.', __METHOD__, Languages::class, Scripts::class), E_USER_DEPRECATED);
 
@@ -169,7 +169,7 @@ public static function getLanguageBundle()
      *
      * @deprecated since Symfony 4.3, to be removed in 5.0. Use {@see Locales} instead.
      */
-    public static function getLocaleBundle()
+    public static function getLocaleBundle(): LocaleBundleInterface
     {
         @trigger_error(sprintf('The method "%s()" is deprecated since Symfony 4.3, use "%s" instead.', __METHOD__, Locales::class), E_USER_DEPRECATED);
 
@@ -190,7 +190,7 @@ public static function getLocaleBundle()
      *
      * @deprecated since Symfony 4.3, to be removed in 5.0. Use {@see Countries} instead.
      */
-    public static function getRegionBundle()
+    public static function getRegionBundle(): RegionBundleInterface
     {
         @trigger_error(sprintf('The method "%s()" is deprecated since Symfony 4.3, use "%s" instead.', __METHOD__, Countries::class), E_USER_DEPRECATED);
 
@@ -210,7 +210,7 @@ public static function getRegionBundle()
      *
      * @return string|null The ICU version or NULL if it could not be determined
      */
-    public static function getIcuVersion()
+    public static function getIcuVersion(): ?string
     {
         if (false === self::$icuVersion) {
             if (!self::isExtensionLoaded()) {
@@ -240,7 +240,7 @@ public static function getIcuVersion()
      *
      * @return string The version of the installed ICU data
      */
-    public static function getIcuDataVersion()
+    public static function getIcuDataVersion(): string
     {
         if (false === self::$icuDataVersion) {
             self::$icuDataVersion = trim(file_get_contents(self::getDataDirectory().'/version.txt'));
@@ -254,7 +254,7 @@ public static function getIcuDataVersion()
      *
      * @return string The ICU version of the stub classes
      */
-    public static function getIcuStubVersion()
+    public static function getIcuStubVersion(): string
     {
         return '64.2';
     }
@@ -264,7 +264,7 @@ public static function getIcuStubVersion()
      *
      * @return string The absolute path to the data directory
      */
-    public static function getDataDirectory()
+    public static function getDataDirectory(): string
     {
         return __DIR__.'/Resources/data';
     }
diff --git a/Tests/Collator/AbstractCollatorTest.php b/Tests/Collator/AbstractCollatorTest.php
@@ -54,9 +54,7 @@ public function asortProvider()
     }
 
     /**
-     * @param string $locale
-     *
-     * @return \Collator
+     * @return Collator|\Collator
      */
-    abstract protected function getCollator($locale);
+    abstract protected function getCollator(string $locale);
 }
diff --git a/Tests/Collator/CollatorTest.php b/Tests/Collator/CollatorTest.php
@@ -95,7 +95,7 @@ public function testStaticCreate()
         $this->assertInstanceOf('\Symfony\Component\Intl\Collator\Collator', $collator);
     }
 
-    protected function getCollator($locale)
+    protected function getCollator(?string $locale): Collator
     {
         return new class($locale) extends Collator {
         };
diff --git a/Tests/Collator/Verification/CollatorTest.php b/Tests/Collator/Verification/CollatorTest.php
@@ -29,7 +29,7 @@ protected function setUp(): void
         parent::setUp();
     }
 
-    protected function getCollator($locale)
+    protected function getCollator(?string $locale): \Collator
     {
         return new \Collator($locale);
     }
diff --git a/Tests/Data/Provider/AbstractDataProviderTest.php b/Tests/Data/Provider/AbstractDataProviderTest.php
@@ -756,19 +756,13 @@ protected function getRootLocales()
         return self::$rootLocales;
     }
 
-    /**
-     * @return BundleEntryReader
-     */
-    protected function createEntryReader()
+    protected function createEntryReader(): BundleEntryReader
     {
         $entryReader = new BundleEntryReader($this->createBundleReader());
         $entryReader->setLocaleAliases($this->getLocaleAliases());
 
         return $entryReader;
     }
 
-    /**
-     * @return BundleReaderInterface
-     */
-    abstract protected function createBundleReader();
+    abstract protected function createBundleReader(): BundleReaderInterface;
 }
diff --git a/Tests/Data/Provider/Json/JsonCurrencyDataProviderTest.php b/Tests/Data/Provider/Json/JsonCurrencyDataProviderTest.php
@@ -28,10 +28,7 @@ protected function getDataDirectory()
         return Intl::getDataDirectory();
     }
 
-    /**
-     * @return BundleReaderInterface
-     */
-    protected function createBundleReader()
+    protected function createBundleReader(): BundleReaderInterface
     {
         return new JsonBundleReader();
     }
diff --git a/Tests/Data/Provider/Json/JsonLanguageDataProviderTest.php b/Tests/Data/Provider/Json/JsonLanguageDataProviderTest.php
@@ -28,10 +28,7 @@ protected function getDataDirectory()
         return Intl::getDataDirectory();
     }
 
-    /**
-     * @return BundleReaderInterface
-     */
-    protected function createBundleReader()
+    protected function createBundleReader(): BundleReaderInterface
     {
         return new JsonBundleReader();
     }
diff --git a/Tests/Data/Provider/Json/JsonLocaleDataProviderTest.php b/Tests/Data/Provider/Json/JsonLocaleDataProviderTest.php
@@ -28,10 +28,7 @@ protected function getDataDirectory()
         return Intl::getDataDirectory();
     }
 
-    /**
-     * @return BundleReaderInterface
-     */
-    protected function createBundleReader()
+    protected function createBundleReader(): BundleReaderInterface
     {
         return new JsonBundleReader();
     }
diff --git a/Tests/Data/Provider/Json/JsonRegionDataProviderTest.php b/Tests/Data/Provider/Json/JsonRegionDataProviderTest.php
@@ -28,10 +28,7 @@ protected function getDataDirectory()
         return Intl::getDataDirectory();
     }
 
-    /**
-     * @return BundleReaderInterface
-     */
-    protected function createBundleReader()
+    protected function createBundleReader(): BundleReaderInterface
     {
         return new JsonBundleReader();
     }
diff --git a/Tests/Data/Provider/Json/JsonScriptDataProviderTest.php b/Tests/Data/Provider/Json/JsonScriptDataProviderTest.php
@@ -28,10 +28,7 @@ protected function getDataDirectory()
         return Intl::getDataDirectory();
     }
 
-    /**
-     * @return BundleReaderInterface
-     */
-    protected function createBundleReader()
+    protected function createBundleReader(): BundleReaderInterface
     {
         return new JsonBundleReader();
     }
diff --git a/Tests/DateFormatter/AbstractIntlDateFormatterTest.php b/Tests/DateFormatter/AbstractIntlDateFormatterTest.php
@@ -965,10 +965,7 @@ protected function assertIsIntlSuccess($formatter, $errorMessage, $errorCode)
      */
     abstract protected function getDateFormatter($locale, $datetype, $timetype, $timezone = null, $calendar = IntlDateFormatter::GREGORIAN, $pattern = null);
 
-    /**
-     * @return string
-     */
-    abstract protected function getIntlErrorMessage();
+    abstract protected function getIntlErrorMessage(): string;
 
     /**
      * @return int
@@ -977,8 +974,6 @@ abstract protected function getIntlErrorCode();
 
     /**
      * @param int $errorCode
-     *
-     * @return bool
      */
-    abstract protected function isIntlFailure($errorCode);
+    abstract protected function isIntlFailure($errorCode): bool;
 }
diff --git a/Tests/DateFormatter/IntlDateFormatterTest.php b/Tests/DateFormatter/IntlDateFormatterTest.php
@@ -183,7 +183,7 @@ protected function getDateFormatter($locale, $datetype, $timetype, $timezone = n
         };
     }
 
-    protected function getIntlErrorMessage()
+    protected function getIntlErrorMessage(): string
     {
         return IntlGlobals::getErrorMessage();
     }
@@ -193,7 +193,7 @@ protected function getIntlErrorCode()
         return IntlGlobals::getErrorCode();
     }
 
-    protected function isIntlFailure($errorCode)
+    protected function isIntlFailure($errorCode): bool
     {
         return IntlGlobals::isFailure($errorCode);
     }
diff --git a/Tests/DateFormatter/Verification/IntlDateFormatterTest.php b/Tests/DateFormatter/Verification/IntlDateFormatterTest.php
@@ -68,7 +68,7 @@ protected function getDateFormatter($locale, $datetype, $timetype, $timezone = n
         return $formatter;
     }
 
-    protected function getIntlErrorMessage()
+    protected function getIntlErrorMessage(): string
     {
         return intl_get_error_message();
     }
@@ -78,7 +78,7 @@ protected function getIntlErrorCode()
         return intl_get_error_code();
     }
 
-    protected function isIntlFailure($errorCode)
+    protected function isIntlFailure($errorCode): bool
     {
         return intl_is_failure($errorCode);
     }
diff --git a/Tests/NumberFormatter/AbstractNumberFormatterTest.php b/Tests/NumberFormatter/AbstractNumberFormatterTest.php
@@ -836,18 +836,11 @@ public function testParseWithNotNullPositionValue()
     }
 
     /**
-     * @param string $locale
-     * @param null   $style
-     * @param null   $pattern
-     *
-     * @return \NumberFormatter
+     * @return NumberFormatter|\NumberFormatter
      */
-    abstract protected function getNumberFormatter($locale = 'en', $style = null, $pattern = null);
+    abstract protected function getNumberFormatter(string $locale = 'en', string $style = null, string $pattern = null);
 
-    /**
-     * @return string
-     */
-    abstract protected function getIntlErrorMessage();
+    abstract protected function getIntlErrorMessage(): string;
 
     /**
      * @return int
@@ -856,8 +849,6 @@ abstract protected function getIntlErrorCode();
 
     /**
      * @param int $errorCode
-     *
-     * @return bool
      */
-    abstract protected function isIntlFailure($errorCode);
+    abstract protected function isIntlFailure($errorCode): bool;
 }
diff --git a/Tests/NumberFormatter/NumberFormatterTest.php b/Tests/NumberFormatter/NumberFormatterTest.php
@@ -167,13 +167,13 @@ public function testSetTextAttribute()
         $formatter->setTextAttribute(null, null);
     }
 
-    protected function getNumberFormatter($locale = 'en', $style = null, $pattern = null)
+    protected function getNumberFormatter(?string $locale = 'en', string $style = null, string $pattern = null): NumberFormatter
     {
         return new class($locale, $style, $pattern) extends NumberFormatter {
         };
     }
 
-    protected function getIntlErrorMessage()
+    protected function getIntlErrorMessage(): string
     {
         return IntlGlobals::getErrorMessage();
     }
@@ -183,7 +183,7 @@ protected function getIntlErrorCode()
         return IntlGlobals::getErrorCode();
     }
 
-    protected function isIntlFailure($errorCode)
+    protected function isIntlFailure($errorCode): bool
     {
         return IntlGlobals::isFailure($errorCode);
     }
diff --git a/Tests/NumberFormatter/Verification/NumberFormatterTest.php b/Tests/NumberFormatter/Verification/NumberFormatterTest.php
@@ -39,12 +39,12 @@ public function testGetTextAttribute()
         parent::testGetTextAttribute();
     }
 
-    protected function getNumberFormatter($locale = 'en', $style = null, $pattern = null)
+    protected function getNumberFormatter(?string $locale = 'en', string $style = null, string $pattern = null): \NumberFormatter
     {
         return new \NumberFormatter($locale, $style, $pattern);
     }
 
-    protected function getIntlErrorMessage()
+    protected function getIntlErrorMessage(): string
     {
         return intl_get_error_message();
     }
@@ -54,7 +54,7 @@ protected function getIntlErrorCode()
         return intl_get_error_code();
     }
 
-    protected function isIntlFailure($errorCode)
+    protected function isIntlFailure($errorCode): bool
     {
         return intl_is_failure($errorCode);
     }

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ final class Intl`
`109`	`109`	`*`
`110`	`110`	`* @return bool Returns true if the intl extension is installed, false otherwise`
`111`	`111`	`*/`
`112`		`- public static function isExtensionLoaded()`
	`112`	`+ public static function isExtensionLoaded(): bool`
`113`	`113`	`{`
`114`	`114`	`return class_exists('\ResourceBundle');`
`115`	`115`	`}`
`@@ -121,7 +121,7 @@ public static function isExtensionLoaded()`
`121`	`121`	`*`
`122`	`122`	`* @deprecated since Symfony 4.3, to be removed in 5.0. Use {@see Currencies} instead.`
`123`	`123`	`*/`
`124`		`- public static function getCurrencyBundle()`
	`124`	`+ public static function getCurrencyBundle(): CurrencyBundleInterface`
`125`	`125`	`{`
`126`	`126`	`@trigger_error(sprintf('The method "%s()" is deprecated since Symfony 4.3, use "%s" instead.', __METHOD__, Currencies::class), E_USER_DEPRECATED);`
`127`	`127`
`@@ -143,7 +143,7 @@ public static function getCurrencyBundle()`
`143`	`143`	`*`
`144`	`144`	`* @deprecated since Symfony 4.3, to be removed in 5.0. Use {@see Languages} or {@see Scripts} instead.`
`145`	`145`	`*/`
`146`		`- public static function getLanguageBundle()`
	`146`	`+ public static function getLanguageBundle(): LanguageBundleInterface`
`147`	`147`	`{`
`148`	`148`	`@trigger_error(sprintf('The method "%s()" is deprecated since Symfony 4.3, use "%s" or "%s" instead.', __METHOD__, Languages::class, Scripts::class), E_USER_DEPRECATED);`
`149`	`149`
`@@ -169,7 +169,7 @@ public static function getLanguageBundle()`
`169`	`169`	`*`
`170`	`170`	`* @deprecated since Symfony 4.3, to be removed in 5.0. Use {@see Locales} instead.`
`171`	`171`	`*/`
`172`		`- public static function getLocaleBundle()`
	`172`	`+ public static function getLocaleBundle(): LocaleBundleInterface`
`173`	`173`	`{`
`174`	`174`	`@trigger_error(sprintf('The method "%s()" is deprecated since Symfony 4.3, use "%s" instead.', __METHOD__, Locales::class), E_USER_DEPRECATED);`
`175`	`175`
`@@ -190,7 +190,7 @@ public static function getLocaleBundle()`
`190`	`190`	`*`
`191`	`191`	`* @deprecated since Symfony 4.3, to be removed in 5.0. Use {@see Countries} instead.`
`192`	`192`	`*/`
`193`		`- public static function getRegionBundle()`
	`193`	`+ public static function getRegionBundle(): RegionBundleInterface`
`194`	`194`	`{`
`195`	`195`	`@trigger_error(sprintf('The method "%s()" is deprecated since Symfony 4.3, use "%s" instead.', __METHOD__, Countries::class), E_USER_DEPRECATED);`
`196`	`196`
`@@ -210,7 +210,7 @@ public static function getRegionBundle()`
`210`	`210`	`*`
`211`	`211`	`* @return string\|null The ICU version or NULL if it could not be determined`
`212`	`212`	`*/`
`213`		`- public static function getIcuVersion()`
	`213`	`+ public static function getIcuVersion(): ?string`
`214`	`214`	`{`
`215`	`215`	`if (false === self::$icuVersion) {`
`216`	`216`	`if (!self::isExtensionLoaded()) {`
`@@ -240,7 +240,7 @@ public static function getIcuVersion()`
`240`	`240`	`*`
`241`	`241`	`* @return string The version of the installed ICU data`
`242`	`242`	`*/`
`243`		`- public static function getIcuDataVersion()`
	`243`	`+ public static function getIcuDataVersion(): string`
`244`	`244`	`{`
`245`	`245`	`if (false === self::$icuDataVersion) {`
`246`	`246`	`self::$icuDataVersion = trim(file_get_contents(self::getDataDirectory().'/version.txt'));`
`@@ -254,7 +254,7 @@ public static function getIcuDataVersion()`
`254`	`254`	`*`
`255`	`255`	`* @return string The ICU version of the stub classes`
`256`	`256`	`*/`
`257`		`- public static function getIcuStubVersion()`
	`257`	`+ public static function getIcuStubVersion(): string`
`258`	`258`	`{`
`259`	`259`	`return '64.2';`
`260`	`260`	`}`
`@@ -264,7 +264,7 @@ public static function getIcuStubVersion()`
`264`	`264`	`*`
`265`	`265`	`* @return string The absolute path to the data directory`
`266`	`266`	`*/`
`267`		`- public static function getDataDirectory()`
	`267`	`+ public static function getDataDirectory(): string`
`268`	`268`	`{`
`269`	`269`	`return __DIR__.'/Resources/data';`
`270`	`270`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,9 +54,7 @@ public function asortProvider()`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`/**`
`57`		`- * @param string $locale`
`58`		`- *`
`59`		`- * @return \Collator`
	`57`	`+ * @return Collator\|\Collator`
`60`	`58`	`*/`
`61`		`- abstract protected function getCollator($locale);`
	`59`	`+ abstract protected function getCollator(string $locale);`
`62`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public function testStaticCreate()`
`95`	`95`	`$this->assertInstanceOf('\Symfony\Component\Intl\Collator\Collator', $collator);`
`96`	`96`	`}`
`97`	`97`
`98`		`- protected function getCollator($locale)`
	`98`	`+ protected function getCollator(?string $locale): Collator`
`99`	`99`	`{`
`100`	`100`	`return new class($locale) extends Collator {`
`101`	`101`	`};`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ protected function setUp(): void`
`29`	`29`	`parent::setUp();`
`30`	`30`	`}`
`31`	`31`
`32`		`- protected function getCollator($locale)`
	`32`	`+ protected function getCollator(?string $locale): \Collator`
`33`	`33`	`{`
`34`	`34`	`return new \Collator($locale);`
`35`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -756,19 +756,13 @@ protected function getRootLocales()`
`756`	`756`	`return self::$rootLocales;`
`757`	`757`	`}`
`758`	`758`
`759`		`- /**`
`760`		`- * @return BundleEntryReader`
`761`		`- */`
`762`		`- protected function createEntryReader()`
	`759`	`+ protected function createEntryReader(): BundleEntryReader`
`763`	`760`	`{`
`764`	`761`	`$entryReader = new BundleEntryReader($this->createBundleReader());`
`765`	`762`	`$entryReader->setLocaleAliases($this->getLocaleAliases());`
`766`	`763`
`767`	`764`	`return $entryReader;`
`768`	`765`	`}`
`769`	`766`
`770`		`- /**`
`771`		`- * @return BundleReaderInterface`
`772`		`- */`
`773`		`- abstract protected function createBundleReader();`
	`767`	`+ abstract protected function createBundleReader(): BundleReaderInterface;`
`774`	`768`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,10 +28,7 @@ protected function getDataDirectory()`
`28`	`28`	`return Intl::getDataDirectory();`
`29`	`29`	`}`
`30`	`30`
`31`		`- /**`
`32`		`- * @return BundleReaderInterface`
`33`		`- */`
`34`		`- protected function createBundleReader()`
	`31`	`+ protected function createBundleReader(): BundleReaderInterface`
`35`	`32`	`{`
`36`	`33`	`return new JsonBundleReader();`
`37`	`34`	`}`