giggsey / libphonenumber-for-php

build/libphonenumber/buildtools/BuildMetadataFromXml.php

Doc Comments +4 added lines, -1 removed lines

@@ -245,6 +245,9 @@ 
         }
     }
 
+    /**
+     * @param string $nationalPrefix
+     */
     private static function getDomesticCarrierCodeFormattingRuleFromElement(\DOMElement $element, $nationalPrefix)
     {
         $carrierCodeFormattingRule = $element->getAttribute(self::CARRIER_CODE_FORMATTING_RULE);
@@ -431,7 +434,7 @@ 
     }
 
     /**
-     * @param $metadataCollection PhoneMetadata[]
+     * @param PhoneMetadata[] $metadataCollection PhoneMetadata[]
      * @return array
      */
     public static function buildCountryCodeToRegionCodeMap($metadataCollection)

build/libphonenumber/buildtools/GeneratePhonePrefixData.php

Doc Comments +7 added lines, -1 removed lines

@@ -157,7 +157,7 @@ 
      * Reads phone prefix data from the provides file path and invokes the given handler for each
      * mapping read.
      *
-     * @param $filePath
+     * @param string $filePath
      * @param $handler
      * @return array
      * @throws \InvalidArgumentException
@@ -204,6 +204,9 @@ 
         return $this->getFilePath($language . DIRECTORY_SEPARATOR . $code . self::DATA_FILE_EXTENSION);
     }
 
+    /**
+     * @param string $fileName
+     */
     private function getFilePath($fileName)
     {
         $path = $this->inputDir . $fileName;
@@ -279,6 +282,9 @@ 
         $this->compressAccordingToEnglishData($this->englishMaps[$countryCode], $mappings);
     }
 
+    /**
+     * @param string $textFile
+     */
     private function getEnglishDataPath($textFile)
     {
         return "en" . DIRECTORY_SEPARATOR . substr($textFile, 3, 2) . self::DATA_FILE_EXTENSION;

src/libphonenumber/geocoding/PhoneNumberOfflineGeocoder.php

Doc Comments +4 added lines, -1 removed lines

@@ -25,6 +25,9 @@ 
      */
     private $prefixFileReader = null;
 
+    /**
+     * @param string $phonePrefixDataDirectory
+     */
     private function __construct($phonePrefixDataDirectory)
     {
         if(!extension_loaded('intl')) {
@@ -104,7 +107,7 @@ 
      * number is from. If it could be from many territories, nothing is returned.
      *
      * @param PhoneNumber $number
-     * @param $locale
+     * @param string $locale
      * @return string
      */
     private function getCountryNameForNumber(PhoneNumber $number, $locale)

src/libphonenumber/PhoneNumberUtil.php

Doc Comments +7 added lines, -3 removed lines

@@ -1758,7 +1758,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 $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)
@@ -2660,7 +2660,7 @@ 
 
     /**
      * Cleans all non-digit characters off of a phone number preserving a leading + sign if one is supplied.
-     * @param $phoneNumber String phone number that you want to clean
+     * @param string $phoneNumber String phone number that you want to clean
      * @return string
      */
     public function cleanPhoneNumber($phoneNumber)
@@ -2721,7 +2721,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)
@@ -3114,6 +3114,10 @@ 
         $this->stringEndsWithString($secondNumberNationalNumber, $firstNumberNationalNumber);
     }
 
+    /**
+     * @param string $hayStack
+     * @param string $needle
+     */
     protected function stringEndsWithString($hayStack, $needle)
     {
         $revNeedle = strrev($needle);