Merge branch '4.4'

nicolas-grekas · nicolas-grekas · commit 07181ac4af67 · 2019-08-20T18:53:57.000+02:00
* 4.4:
  some backports from master
  Add return types to internal|final|private methods
  [HttpFoundation] Precalculate session expiry timestamp
diff --git a/Data/Generator/AbstractDataGenerator.php b/Data/Generator/AbstractDataGenerator.php
@@ -93,24 +93,15 @@ public function generateData(GeneratorConfig $config)
     /**
      * @return string[]
      */
-    abstract protected function scanLocales(LocaleScanner $scanner, string $sourceDir);
+    abstract protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array;
 
     abstract protected function compileTemporaryBundles(BundleCompilerInterface $compiler, string $sourceDir, string $tempDir);
 
     abstract protected function preGenerate();
 
-    /**
-     * @return array|null
-     */
-    abstract protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale);
+    abstract protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array;
 
-    /**
-     * @return array|null
-     */
-    abstract protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir);
+    abstract protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array;
 
-    /**
-     * @return array|null
-     */
-    abstract protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir);
+    abstract protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array;
 }
diff --git a/Data/Generator/CurrencyDataGenerator.php b/Data/Generator/CurrencyDataGenerator.php
@@ -51,7 +51,7 @@ class CurrencyDataGenerator extends AbstractDataGenerator
     /**
      * {@inheritdoc}
      */
-    protected function scanLocales(LocaleScanner $scanner, string $sourceDir)
+    protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array
     {
         return $scanner->scanLocales($sourceDir.'/curr');
     }
@@ -76,7 +76,7 @@ protected function preGenerate()
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)
+    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array
     {
         $localeBundle = $reader->read($tempDir, $displayLocale);
 
@@ -97,7 +97,7 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
         $rootBundle = $reader->read($tempDir, 'root');
 
@@ -110,7 +110,7 @@ protected function generateDataForRoot(BundleEntryReaderInterface $reader, strin
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
         $rootBundle = $reader->read($tempDir, 'root');
         $supplementalDataBundle = $reader->read($tempDir, 'supplementalData');
diff --git a/Data/Generator/GeneratorConfig.php b/Data/Generator/GeneratorConfig.php
@@ -49,7 +49,7 @@ public function addBundleWriter(string $targetDir, BundleWriterInterface $writer
      *
      * @return BundleWriterInterface[]
      */
-    public function getBundleWriters()
+    public function getBundleWriters(): array
     {
         return $this->bundleWriters;
     }
@@ -60,7 +60,7 @@ public function getBundleWriters()
      *
      * @return string An absolute path to a directory
      */
-    public function getSourceDir()
+    public function getSourceDir(): string
     {
         return $this->sourceDir;
     }
@@ -70,7 +70,7 @@ public function getSourceDir()
      *
      * @return string The ICU version string
      */
-    public function getIcuVersion()
+    public function getIcuVersion(): string
     {
         return $this->icuVersion;
     }
diff --git a/Data/Generator/LanguageDataGenerator.php b/Data/Generator/LanguageDataGenerator.php
@@ -101,7 +101,7 @@ class LanguageDataGenerator extends AbstractDataGenerator
     /**
      * {@inheritdoc}
      */
-    protected function scanLocales(LocaleScanner $scanner, string $sourceDir)
+    protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array
     {
         return $scanner->scanLocales($sourceDir.'/lang');
     }
@@ -126,7 +126,7 @@ protected function preGenerate()
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)
+    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array
     {
         $localeBundle = $reader->read($tempDir, $displayLocale);
 
@@ -148,14 +148,14 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
         $rootBundle = $reader->read($tempDir, 'root');
         $metadataBundle = $reader->read($tempDir, 'metadata');
diff --git a/Data/Generator/LocaleDataGenerator.php b/Data/Generator/LocaleDataGenerator.php
@@ -36,7 +36,7 @@ class LocaleDataGenerator extends AbstractDataGenerator
     /**
      * {@inheritdoc}
      */
-    protected function scanLocales(LocaleScanner $scanner, string $sourceDir)
+    protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array
     {
         $this->locales = $scanner->scanLocales($sourceDir.'/locales');
         $this->localeAliases = $scanner->scanAliases($sourceDir.'/locales');
@@ -74,7 +74,7 @@ protected function preGenerate()
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)
+    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array
     {
         // Don't generate aliases, as they are resolved during runtime
         // Unless an alias is needed as fallback for de-duplication purposes
@@ -133,14 +133,14 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
         return [
             'Locales' => $this->locales,
diff --git a/Data/Generator/RegionDataGenerator.php b/Data/Generator/RegionDataGenerator.php
@@ -84,7 +84,7 @@ public static function isValidCountryCode($region)
     /**
      * {@inheritdoc}
      */
-    protected function scanLocales(LocaleScanner $scanner, string $sourceDir)
+    protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array
     {
         return $scanner->scanLocales($sourceDir.'/region');
     }
@@ -109,7 +109,7 @@ protected function preGenerate()
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)
+    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array
     {
         $localeBundle = $reader->read($tempDir, $displayLocale);
 
@@ -131,14 +131,14 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
         $rootBundle = $reader->read($tempDir, 'root');
         $metadataBundle = $reader->read($tempDir, 'metadata');
diff --git a/Data/Generator/ScriptDataGenerator.php b/Data/Generator/ScriptDataGenerator.php
@@ -38,7 +38,7 @@ class ScriptDataGenerator extends AbstractDataGenerator
     /**
      * {@inheritdoc}
      */
-    protected function scanLocales(LocaleScanner $scanner, string $sourceDir)
+    protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array
     {
         return $scanner->scanLocales($sourceDir.'/lang');
     }
@@ -62,7 +62,7 @@ protected function preGenerate()
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)
+    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array
     {
         $localeBundle = $reader->read($tempDir, $displayLocale);
 
@@ -84,14 +84,14 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
         $rootBundle = $reader->read($tempDir, 'root');
 
diff --git a/Data/Generator/TimezoneDataGenerator.php b/Data/Generator/TimezoneDataGenerator.php
@@ -42,7 +42,7 @@ class TimezoneDataGenerator extends AbstractDataGenerator
     /**
      * {@inheritdoc}
      */
-    protected function scanLocales(LocaleScanner $scanner, string $sourceDir)
+    protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array
     {
         $this->localeAliases = $scanner->scanAliases($sourceDir.'/locales');
 
@@ -75,7 +75,7 @@ protected function preGenerate()
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)
+    protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array
     {
         if (!$this->zoneToCountryMapping) {
             $this->zoneToCountryMapping = self::generateZoneToCountryMapping($reader->read($tempDir, 'windowsZones'));
@@ -126,7 +126,7 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
         $rootBundle = $reader->read($tempDir, 'root');
 
@@ -139,7 +139,7 @@ protected function generateDataForRoot(BundleEntryReaderInterface $reader, strin
     /**
      * {@inheritdoc}
      */
-    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)
+    protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array
     {
         $rootBundle = $reader->read($tempDir, 'root');
 
diff --git a/Data/Util/LocaleScanner.php b/Data/Util/LocaleScanner.php
@@ -33,14 +33,12 @@ class LocaleScanner
     /**
      * Returns all locales found in the given directory.
      *
-     * @param string $sourceDir The directory with ICU files
-     *
      * @return array An array of locales. The result also contains locales that
      *               are in fact just aliases for other locales. Use
      *               {@link scanAliases()} to determine which of the locales
      *               are aliases
      */
-    public function scanLocales(string $sourceDir)
+    public function scanLocales(string $sourceDir): array
     {
         $locales = glob($sourceDir.'/*.txt');
 
@@ -60,12 +58,10 @@ public function scanLocales(string $sourceDir)
     /**
      * Returns all locale aliases found in the given directory.
      *
-     * @param string $sourceDir The directory with ICU files
-     *
      * @return array An array with the locale aliases as keys and the aliased
      *               locales as values
      */
-    public function scanAliases(string $sourceDir)
+    public function scanAliases(string $sourceDir): array
     {
         $locales = $this->scanLocales($sourceDir);
         $aliases = [];
diff --git a/DateFormatter/DateFormat/FullTransformer.php b/DateFormatter/DateFormat/FullTransformer.php
@@ -74,7 +74,7 @@ public function __construct(string $pattern, string $timezone)
      *
      * @return string The formatted value
      */
-    public function format(\DateTime $dateTime)
+    public function format(\DateTime $dateTime): string
     {
         $formatted = preg_replace_callback($this->regExp, function ($matches) use ($dateTime) {
             return $this->formatReplace($matches[0], $dateTime);
diff --git a/DateFormatter/DateFormat/TimezoneTransformer.php b/DateFormatter/DateFormat/TimezoneTransformer.php
@@ -97,7 +97,7 @@ public function extractDateOptions(string $matched, int $length): array
      * @throws NotImplementedException   When the GMT time zone have minutes offset different than zero
      * @throws \InvalidArgumentException When the value can not be matched with pattern
      */
-    public static function getEtcTimeZoneId(string $formattedTimeZone)
+    public static function getEtcTimeZoneId(string $formattedTimeZone): string
     {
         if (preg_match('/GMT(?P<signal>[+-])(?P<hours>\d{2}):?(?P<minutes>\d{2})/', $formattedTimeZone, $matches)) {
             $hours = (int) $matches['hours'];
diff --git a/Globals/IntlGlobals.php b/Globals/IntlGlobals.php
@@ -58,10 +58,8 @@ abstract class IntlGlobals
      * Returns whether the error code indicates a failure.
      *
      * @param int $errorCode The error code returned by IntlGlobals::getErrorCode()
-     *
-     * @return bool
      */
-    public static function isFailure(int $errorCode)
+    public static function isFailure(int $errorCode): bool
     {
         return isset(self::$errorCodes[$errorCode])
             && $errorCode > self::U_ZERO_ERROR;
@@ -83,10 +81,8 @@ public static function getErrorCode()
      * Returns the error message of the last operation.
      *
      * Returns "U_ZERO_ERROR" if no error occurred.
-     *
-     * @return string
      */
-    public static function getErrorMessage()
+    public static function getErrorMessage(): string
     {
         return self::$errorMessage;
     }
@@ -95,10 +91,8 @@ public static function getErrorMessage()
      * Returns the symbolic name for a given error code.
      *
      * @param int $code The error code returned by IntlGlobals::getErrorCode()
-     *
-     * @return string
      */
-    public static function getErrorName(int $code)
+    public static function getErrorName(int $code): string
     {
         return self::$errorCodes[$code] ?? '[BOGUS UErrorCode]';
     }

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public function addBundleWriter(string $targetDir, BundleWriterInterface $writer`
`49`	`49`	`*`
`50`	`50`	`* @return BundleWriterInterface[]`
`51`	`51`	`*/`
`52`		`- public function getBundleWriters()`
	`52`	`+ public function getBundleWriters(): array`
`53`	`53`	`{`
`54`	`54`	`return $this->bundleWriters;`
`55`	`55`	`}`
`@@ -60,7 +60,7 @@ public function getBundleWriters()`
`60`	`60`	`*`
`61`	`61`	`* @return string An absolute path to a directory`
`62`	`62`	`*/`
`63`		`- public function getSourceDir()`
	`63`	`+ public function getSourceDir(): string`
`64`	`64`	`{`
`65`	`65`	`return $this->sourceDir;`
`66`	`66`	`}`
`@@ -70,7 +70,7 @@ public function getSourceDir()`
`70`	`70`	`*`
`71`	`71`	`* @return string The ICU version string`
`72`	`72`	`*/`
`73`		`- public function getIcuVersion()`
	`73`	`+ public function getIcuVersion(): string`
`74`	`74`	`{`
`75`	`75`	`return $this->icuVersion;`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ class LanguageDataGenerator extends AbstractDataGenerator`
`101`	`101`	`/**`
`102`	`102`	`* {@inheritdoc}`
`103`	`103`	`*/`
`104`		`- protected function scanLocales(LocaleScanner $scanner, string $sourceDir)`
	`104`	`+ protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array`
`105`	`105`	`{`
`106`	`106`	`return $scanner->scanLocales($sourceDir.'/lang');`
`107`	`107`	`}`
`@@ -126,7 +126,7 @@ protected function preGenerate()`
`126`	`126`	`/**`
`127`	`127`	`* {@inheritdoc}`
`128`	`128`	`*/`
`129`		`- protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)`
	`129`	`+ protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array`
`130`	`130`	`{`
`131`	`131`	`$localeBundle = $reader->read($tempDir, $displayLocale);`
`132`	`132`
`@@ -148,14 +148,14 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str`
`148`	`148`	`/**`
`149`	`149`	`* {@inheritdoc}`
`150`	`150`	`*/`
`151`		`- protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)`
	`151`	`+ protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array`
`152`	`152`	`{`
`153`	`153`	`}`
`154`	`154`
`155`	`155`	`/**`
`156`	`156`	`* {@inheritdoc}`
`157`	`157`	`*/`
`158`		`- protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)`
	`158`	`+ protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array`
`159`	`159`	`{`
`160`	`160`	`$rootBundle = $reader->read($tempDir, 'root');`
`161`	`161`	`$metadataBundle = $reader->read($tempDir, 'metadata');`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public static function isValidCountryCode($region)`
`84`	`84`	`/**`
`85`	`85`	`* {@inheritdoc}`
`86`	`86`	`*/`
`87`		`- protected function scanLocales(LocaleScanner $scanner, string $sourceDir)`
	`87`	`+ protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array`
`88`	`88`	`{`
`89`	`89`	`return $scanner->scanLocales($sourceDir.'/region');`
`90`	`90`	`}`
`@@ -109,7 +109,7 @@ protected function preGenerate()`
`109`	`109`	`/**`
`110`	`110`	`* {@inheritdoc}`
`111`	`111`	`*/`
`112`		`- protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)`
	`112`	`+ protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array`
`113`	`113`	`{`
`114`	`114`	`$localeBundle = $reader->read($tempDir, $displayLocale);`
`115`	`115`
`@@ -131,14 +131,14 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str`
`131`	`131`	`/**`
`132`	`132`	`* {@inheritdoc}`
`133`	`133`	`*/`
`134`		`- protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)`
	`134`	`+ protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array`
`135`	`135`	`{`
`136`	`136`	`}`
`137`	`137`
`138`	`138`	`/**`
`139`	`139`	`* {@inheritdoc}`
`140`	`140`	`*/`
`141`		`- protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)`
	`141`	`+ protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array`
`142`	`142`	`{`
`143`	`143`	`$rootBundle = $reader->read($tempDir, 'root');`
`144`	`144`	`$metadataBundle = $reader->read($tempDir, 'metadata');`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ class ScriptDataGenerator extends AbstractDataGenerator`
`38`	`38`	`/**`
`39`	`39`	`* {@inheritdoc}`
`40`	`40`	`*/`
`41`		`- protected function scanLocales(LocaleScanner $scanner, string $sourceDir)`
	`41`	`+ protected function scanLocales(LocaleScanner $scanner, string $sourceDir): array`
`42`	`42`	`{`
`43`	`43`	`return $scanner->scanLocales($sourceDir.'/lang');`
`44`	`44`	`}`
`@@ -62,7 +62,7 @@ protected function preGenerate()`
`62`	`62`	`/**`
`63`	`63`	`* {@inheritdoc}`
`64`	`64`	`*/`
`65`		`- protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale)`
	`65`	`+ protected function generateDataForLocale(BundleEntryReaderInterface $reader, string $tempDir, string $displayLocale): ?array`
`66`	`66`	`{`
`67`	`67`	`$localeBundle = $reader->read($tempDir, $displayLocale);`
`68`	`68`
`@@ -84,14 +84,14 @@ protected function generateDataForLocale(BundleEntryReaderInterface $reader, str`
`84`	`84`	`/**`
`85`	`85`	`* {@inheritdoc}`
`86`	`86`	`*/`
`87`		`- protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir)`
	`87`	`+ protected function generateDataForRoot(BundleEntryReaderInterface $reader, string $tempDir): ?array`
`88`	`88`	`{`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`/**`
`92`	`92`	`* {@inheritdoc}`
`93`	`93`	`*/`
`94`		`- protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir)`
	`94`	`+ protected function generateDataForMeta(BundleEntryReaderInterface $reader, string $tempDir): ?array`
`95`	`95`	`{`
`96`	`96`	`$rootBundle = $reader->read($tempDir, 'root');`
`97`	`97`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public function __construct(string $pattern, string $timezone)`
`74`	`74`	`*`
`75`	`75`	`* @return string The formatted value`
`76`	`76`	`*/`
`77`		`- public function format(\DateTime $dateTime)`
	`77`	`+ public function format(\DateTime $dateTime): string`
`78`	`78`	`{`
`79`	`79`	`$formatted = preg_replace_callback($this->regExp, function ($matches) use ($dateTime) {`
`80`	`80`	`return $this->formatReplace($matches[0], $dateTime);`