giggsey / libphonenumber-for-php

src/PhoneNumberMatcher.php

Doc Comments +14 added lines, -2 removed lines

@@ -181,6 +181,9 @@ 
         static::$initialized = true;
     }
 
+    /**
+     * @param integer $lower
+     */
     private static function limit($lower, $upper)
     {
         if (($lower < 0) || ($upper <= 0) || ($upper < $lower)) {
@@ -274,6 +277,9 @@ 
         }
     }
 
+    /**
+     * @param integer $index
+     */
     private function find($index)
     {
         $matcher = new Matcher(self::$pattern, $this->text);
@@ -337,6 +343,9 @@ 
         || preg_match('/\pM+/u', $letter);
     }
 
+    /**
+     * @param string $character
+     */
     private static function isInvalidPunctuationSymbol($character)
     {
         return $character == '%' || preg_match('/\p{Sc}/u', $character);
@@ -706,6 +715,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $candidate
+     */
     public static function containsOnlyValidXChars(PhoneNumber $number, $candidate, PhoneNumberUtil $util)
     {
         // The characters 'x' and 'X' can be (1) a carrier code, in which case they always precede the
@@ -794,7 +806,7 @@ 
     private static $callingCodeToAlternateFormatsMap = array();
 
     /**
-     * @param $countryCallingCode
+     * @param integer|null $countryCallingCode
      * @return PhoneMetadata|null
      */
     private static function getAlternateFormatsForCountry($countryCallingCode)
@@ -860,7 +872,7 @@ 
     /**
      * Return the key of the current element
      * @link http://php.net/manual/en/iterator.key.php
-     * @return mixed scalar on success, or null on failure.
+     * @return integer scalar on success, or null on failure.
      * @since 5.0.0
      */
     public function key()

src/PhoneNumberUtil.php

Doc Comments +6 added lines, -2 removed lines

@@ -1876,7 +1876,7 @@ 
      * Normalizes a string of characters representing a phone number. This converts wide-ascii and
      * arabic-indic numerals to European numerals, and strips punctuation and alpha characters.
      *
-     * @param $number string  a string of characters representing a phone number
+     * @param string|null $number string  a string of characters representing a phone number
      * @return string the normalized string version of the phone number
      */
     public static function normalizeDigitsOnly($number)
@@ -2850,7 +2850,7 @@ 
      *
      * @param PhoneNumber $number the phone number to be formatted
      * @param int $numberFormat the format the phone number should be formatted into
-     * @param array $userDefinedFormats formatting rules specified by clients
+     * @param NumberFormat[] $userDefinedFormats formatting rules specified by clients
      * @return String the formatted phone number
      */
     public function formatByPattern(PhoneNumber $number, $numberFormat, array $userDefinedFormats)
@@ -3244,6 +3244,10 @@ 
         $this->stringEndsWithString($secondNumberNationalNumber, $firstNumberNationalNumber);
     }
 
+    /**
+     * @param string $hayStack
+     * @param string $needle
+     */
     protected function stringEndsWithString($hayStack, $needle)
     {
         $revNeedle = strrev($needle);