minor #32786 add parameter type declarations to private methods (xabbuh)

This PR was merged into the 4.4 branch.

Discussion
----------

add parameter type declarations to private methods

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        |

Commits
-------

1b2aaa4a06 add parameter type declarations to private methods

Author: fabpot

Data/Bundle/Writer/TextBundleWriter.php

@@ -43,15 +43,12 @@ public function write($path, $locale, $data, $fallback = true)
     /**
      * Writes a "resourceBundle" node.
      *
-     * @param resource $file       The file handle to write to
-     * @param string   $bundleName The name of the bundle
-     * @param mixed    $value      The value of the node
-     * @param bool     $fallback   Whether the resource bundle should be merged
-     *                             with the fallback locale
+     * @param resource $file  The file handle to write to
+     * @param mixed    $value The value of the node
      *
      * @see http://source.icu-project.org/repos/icu/icuhtml/trunk/design/bnf_rb.txt
      */
-    private function writeResourceBundle($file, $bundleName, $value, $fallback)
+    private function writeResourceBundle($file, string $bundleName, $value, bool $fallback)
     {
         fwrite($file, $bundleName);
 
@@ -63,14 +60,12 @@ private function writeResourceBundle($file, $bundleName, $value, $fallback)
     /**
      * Writes a "resource" node.
      *
-     * @param resource $file          The file handle to write to
-     * @param mixed    $value         The value of the node
-     * @param int      $indentation   The number of levels to indent
-     * @param bool     $requireBraces Whether to require braces to be printedaround the value
+     * @param resource $file  The file handle to write to
+     * @param mixed    $value The value of the node
      *
      * @see http://source.icu-project.org/repos/icu/icuhtml/trunk/design/bnf_rb.txt
      */
-    private function writeResource($file, $value, $indentation, $requireBraces = true)
+    private function writeResource($file, $value, int $indentation, bool $requireBraces = true)
     {
         if (\is_int($value)) {
             $this->writeInteger($file, $value);
@@ -117,26 +112,23 @@ private function writeResource($file, $value, $indentation, $requireBraces = tru
     /**
      * Writes an "integer" node.
      *
-     * @param resource $file  The file handle to write to
-     * @param int      $value The value of the node
+     * @param resource $file The file handle to write to
      *
      * @see http://source.icu-project.org/repos/icu/icuhtml/trunk/design/bnf_rb.txt
      */
-    private function writeInteger($file, $value)
+    private function writeInteger($file, int $value)
     {
         fprintf($file, ':int{%d}', $value);
     }
 
     /**
      * Writes an "intvector" node.
      *
-     * @param resource $file        The file handle to write to
-     * @param array    $value       The value of the node
-     * @param int      $indentation The number of levels to indent
+     * @param resource $file The file handle to write to
      *
      * @see http://source.icu-project.org/repos/icu/icuhtml/trunk/design/bnf_rb.txt
      */
-    private function writeIntVector($file, array $value, $indentation)
+    private function writeIntVector($file, array $value, int $indentation)
     {
         fwrite($file, ":intvector{\n");
 
@@ -150,14 +142,11 @@ private function writeIntVector($file, array $value, $indentation)
     /**
      * Writes a "string" node.
      *
-     * @param resource $file          The file handle to write to
-     * @param string   $value         The value of the node
-     * @param bool     $requireBraces Whether to require braces to be printed
-     *                                around the value
+     * @param resource $file The file handle to write to
      *
      * @see http://source.icu-project.org/repos/icu/icuhtml/trunk/design/bnf_rb.txt
      */
-    private function writeString($file, $value, $requireBraces = true)
+    private function writeString($file, string $value, bool $requireBraces = true)
     {
         if ($requireBraces) {
             fprintf($file, '{"%s"}', $value);
@@ -171,13 +160,11 @@ private function writeString($file, $value, $requireBraces = true)
     /**
      * Writes an "array" node.
      *
-     * @param resource $file        The file handle to write to
-     * @param array    $value       The value of the node
-     * @param int      $indentation The number of levels to indent
+     * @param resource $file The file handle to write to
      *
      * @see http://source.icu-project.org/repos/icu/icuhtml/trunk/design/bnf_rb.txt
      */
-    private function writeArray($file, array $value, $indentation)
+    private function writeArray($file, array $value, int $indentation)
     {
         fwrite($file, "{\n");
 
@@ -195,16 +182,12 @@ private function writeArray($file, array $value, $indentation)
     /**
      * Writes a "table" node.
      *
-     * @param resource $file        The file handle to write to
-     * @param iterable $value       The value of the node
-     * @param int      $indentation The number of levels to indent
-     * @param bool     $fallback    Whether the table should be merged
-     *                              with the fallback locale
+     * @param resource $file The file handle to write to
      *
      * @throws UnexpectedTypeException when $value is not an array and not a
      *                                 \Traversable instance
      */
-    private function writeTable($file, $value, $indentation, $fallback = true)
+    private function writeTable($file, iterable $value, int $indentation, bool $fallback = true)
     {
         if (!\is_array($value) && !$value instanceof \Traversable) {
             throw new UnexpectedTypeException($value, 'array or \Traversable');

Data/Generator/LocaleDataGenerator.php

@@ -151,7 +151,7 @@ protected function generateDataForMeta(BundleEntryReaderInterface $reader, $temp
     /**
      * @return string
      */
-    private function generateLocaleName(BundleEntryReaderInterface $reader, $tempDir, $locale, $displayLocale, $pattern, $separator)
+    private function generateLocaleName(BundleEntryReaderInterface $reader, string $tempDir, string $locale, string $displayLocale, string $pattern, string $separator)
     {
         // Apply generic notation using square brackets as described per http://cldr.unicode.org/translation/language-names
         $name = str_replace(['(', ')'], ['[', ']'], $reader->readEntry($tempDir.'/lang', $displayLocale, ['Languages', \Locale::getPrimaryLanguage($locale)]));

NumberFormatter/NumberFormatter.php

@@ -672,15 +672,12 @@ protected function resetError()
      *
      * The only actual rounding data as of this writing, is CHF.
      *
-     * @param float  $value    The numeric currency value
-     * @param string $currency The 3-letter ISO 4217 currency code indicating the currency to use
-     *
      * @return float The rounded numeric currency value
      *
      * @see http://en.wikipedia.org/wiki/Swedish_rounding
      * @see http://www.docjar.com/html/api/com/ibm/icu/util/Currency.java.html#1007
      */
-    private function roundCurrency($value, $currency)
+    private function roundCurrency(float $value, string $currency)
     {
         $fractionDigits = Currencies::getFractionDigits($currency);
         $roundingIncrement = Currencies::getRoundingIncrement($currency);
@@ -700,12 +697,11 @@ private function roundCurrency($value, $currency)
     /**
      * Rounds a value.
      *
-     * @param int|float $value     The value to round
-     * @param int       $precision The number of decimal digits to round to
+     * @param int|float $value The value to round
      *
      * @return int|float The rounded value
      */
-    private function round($value, $precision)
+    private function round($value, int $precision)
     {
         $precision = $this->getUninitializedPrecision($value, $precision);
 
@@ -741,12 +737,11 @@ private function round($value, $precision)
     /**
      * Formats a number.
      *
-     * @param int|float $value     The numeric value to format
-     * @param int       $precision The number of decimal digits to use
+     * @param int|float $value The numeric value to format
      *
      * @return string The formatted number
      */
-    private function formatNumber($value, $precision)
+    private function formatNumber($value, int $precision)
     {
         $precision = $this->getUninitializedPrecision($value, $precision);
 
@@ -756,12 +751,11 @@ private function formatNumber($value, $precision)
     /**
      * Returns the precision value if the DECIMAL style is being used and the FRACTION_DIGITS attribute is uninitialized.
      *
-     * @param int|float $value     The value to get the precision from if the FRACTION_DIGITS attribute is uninitialized
-     * @param int       $precision The precision value to returns if the FRACTION_DIGITS attribute is initialized
+     * @param int|float $value The value to get the precision from if the FRACTION_DIGITS attribute is uninitialized
      *
      * @return int The precision value
      */
-    private function getUninitializedPrecision($value, $precision)
+    private function getUninitializedPrecision($value, int $precision)
     {
         if (self::CURRENCY == $this->style) {
             return $precision;
@@ -780,11 +774,9 @@ private function getUninitializedPrecision($value, $precision)
     /**
      * Check if the attribute is initialized (value set by client code).
      *
-     * @param string $attr The attribute name
-     *
      * @return bool true if the value was set by client, false otherwise
      */
-    private function isInitializedAttribute($attr)
+    private function isInitializedAttribute(string $attr)
     {
         return isset($this->initializedAttributes[$attr]);
     }
@@ -793,11 +785,10 @@ private function isInitializedAttribute($attr)
      * Returns the numeric value using the $type to convert to the right data type.
      *
      * @param mixed $value The value to be converted
-     * @param int   $type  The type to convert. Can be TYPE_DOUBLE (float) or TYPE_INT32 (int)
      *
      * @return int|float|false The converted value
      */
-    private function convertValueDataType($value, $type)
+    private function convertValueDataType($value, int $type)
     {
         if (self::TYPE_DOUBLE == $type) {
             $value = (float) $value;
@@ -813,8 +804,6 @@ private function convertValueDataType($value, $type)
     /**
      * Convert the value data type to int or returns false if the value is out of the integer value range.
      *
-     * @param mixed $value The value to be converted
-     *
      * @return int|false The converted value
      */
     private function getInt32Value($value)
@@ -829,8 +818,6 @@ private function getInt32Value($value)
     /**
      * Convert the value data type to int or returns false if the value is out of the integer value range.
      *
-     * @param mixed $value The value to be converted
-     *
      * @return int|float|false The converted value
      */
     private function getInt64Value($value)
@@ -849,11 +836,9 @@ private function getInt64Value($value)
     /**
      * Check if the rounding mode is invalid.
      *
-     * @param int $value The rounding mode value to check
-     *
      * @return bool true if the rounding mode is invalid, false otherwise
      */
-    private function isInvalidRoundingMode($value)
+    private function isInvalidRoundingMode(int $value)
     {
         if (\in_array($value, self::$roundingModes, true)) {
             return false;
@@ -866,8 +851,6 @@ private function isInvalidRoundingMode($value)
      * Returns the normalized value for the GROUPING_USED attribute. Any value that can be converted to int will be
      * cast to Boolean and then to int again. This way, negative values are converted to 1 and string values to 0.
      *
-     * @param mixed $value The value to be normalized
-     *
      * @return int The normalized value for the attribute (0 or 1)
      */
     private function normalizeGroupingUsedValue($value)
@@ -878,8 +861,6 @@ private function normalizeGroupingUsedValue($value)
     /**
      * Returns the normalized value for the FRACTION_DIGITS attribute.
      *
-     * @param mixed $value The value to be normalized
-     *
      * @return int The normalized value for the attribute
      */
     private function normalizeFractionDigitsValue($value)

Tests/NumberFormatter/NumberFormatterTest.php

@@ -59,7 +59,7 @@ public function testSetAttributeWithUnsupportedAttribute()
     public function testSetAttributeInvalidRoundingMode()
     {
         $formatter = $this->getNumberFormatter('en', NumberFormatter::DECIMAL);
-        $formatter->setAttribute(NumberFormatter::ROUNDING_MODE, null);
+        $formatter->setAttribute(NumberFormatter::ROUNDING_MODE, -1);
     }
 
     public function testConstructWithoutLocale()

Util/GitRepository.php

@@ -85,7 +85,7 @@ public function checkout($branch)
         $this->execInPath(sprintf('git checkout %s', escapeshellarg($branch)));
     }
 
-    private function execInPath($command)
+    private function execInPath(string $command)
     {
         return self::exec(sprintf('cd %s && %s', escapeshellarg($this->path), $command));
     }