antonioribeiro / countries

src/package/Services/Config.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     /**
      * Config constructor.
      *
-     * @param array|null $config
+     * @param Helper $config
      */
     public function __construct($config = null)
     {
@@ -24,7 +24,7 @@ 
     }
 
     /**
-     * @param $key
+     * @param string $key
      * @return \PragmaRX\Coollection\Package\Coollection
      */
     public function get($key)

src/package/Services/Countries.php

Doc Comments +1 added lines, -1 removed lines

@@ -235,7 +235,7 @@
     }
 
     /**
-     * @param $repository
+     * @param null|Repository $repository
      * @return Repository
      */
     protected function instantiateRepository($repository)

src/package/Services/Cache.php

Doc Comments +2 added lines, -2 removed lines

@@ -119,7 +119,7 @@ 
      * Delete an item from the cache by its unique key.
      *
      * @param string $key
-     * @return bool
+     * @return boolean|null
      */
     public function delete($key)
     {
@@ -207,7 +207,7 @@ 
      * Get an item from the cache, or store the default value.
      *
      * @param  string $key
-     * @param  \DateTimeInterface|\DateInterval|float|int $minutes
+     * @param  integer $minutes
      * @param Closure $callback
      * @return mixed
      */

src/package/Services/Helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -64,7 +64,7 @@ 
     /**
      * Load json files from dir.
      *
-     * @param $dir
+     * @param string $dir
      * @return \PragmaRX\Coollection\Package\Coollection
      */
     public function loadJsonFiles($dir)
@@ -105,7 +105,7 @@ 
     }
 
     /**
-     * @param $contents
+     * @param string $contents
      * @return string
      */
     public function sanitizeFile($contents)

src/package/Services/Hydrator.php

Doc Comments +5 added lines, -5 removed lines

@@ -57,7 +57,7 @@ 
      * Can hydrate?
      *
      * @param $element
-     * @param $enabled
+     * @param boolean $enabled
      * @param $countryCode
      * @return bool
      */
@@ -84,7 +84,7 @@ 
      *
      * @param $countries
      * @param $elements
-     * @return mixed
+     * @return \PragmaRX\Countries\Package\Support\Collection
      */
     private function hydrateCountries($countries, $elements = null)
     {
@@ -100,7 +100,7 @@ 
      *
      * @param $country
      * @param $elements
-     * @return mixed
+     * @return \PragmaRX\Countries\Package\Support\Collection
      */
     private function hydrateCountry($country, $elements)
     {
@@ -381,7 +381,7 @@ 
      * Get country by country code.
      *
      * @param $countryCode
-     * @return mixed
+     * @return \PragmaRX\Countries\Package\Support\Collection
      */
     public function getCountry($countryCode)
     {
@@ -438,7 +438,7 @@ 
     /**
      * Repository setter.
      *
-     * @param $repository
+     * @param \PragmaRX\Countries\Package\Data\Repository $repository
      */
     public function setRepository($repository)
     {

src/update/Countries.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
     /**
      * Build countries collection.
      *
-     * @param $dataDir
+     * @param string $dataDir
      * @return \PragmaRX\Coollection\Package\Coollection
      */
     public function buildCountriesCoollection($dataDir)

src/update/Helper.php

Doc Comments +18 added lines, -13 removed lines

@@ -70,9 +70,9 @@ 
     /**
      * Add suffix to string.
      *
-     * @param $suffix
-     * @param $string
-     * @return mixed
+     * @param string string
+     * @param string $string
+     * @return string
      */
     protected function addSuffix($suffix, $string)
     {
@@ -99,7 +99,7 @@ 
     /**
      * Delete a whole directory.
      *
-     * @param $dir
+     * @param string $dir
      */
     protected function deleteDirectory($dir)
     {
@@ -117,6 +117,11 @@ 
         rmdir($dir);
     }
 
+    /**
+     * @param string $string
+     *
+     * @return resource
+     */
     protected function fopenOrFail($url, $string)
     {
         if (($handle = @fopen($url, $string)) === false) {
@@ -185,7 +190,7 @@ 
 
     /**
      * @param $url
-     * @param $destination
+     * @param string $destination
      */
     public function downloadFile($url, $destination)
     {
@@ -256,8 +261,8 @@ 
     /**
      * @param $file
      * @param $subPath
-     * @param $path
-     * @param $exclude
+     * @param string $path
+     * @param string $exclude
      */
     protected function renameMasterToPackage($file, $subPath, $path, $exclude): void
     {
@@ -311,8 +316,8 @@ 
     /**
      * Load a shapeFile.
      *
-     * @param $dir
-     * @return \PragmaRX\Coollection\Package\Coollection
+     * @param string $dir
+     * @return string
      */
     public function shapeFile($dir)
     {
@@ -392,7 +397,7 @@ 
      * Unzip a file.
      *
      * @param $file
-     * @param $path
+     * @param string $path
      */
     public function unzip($file, $path)
     {
@@ -480,7 +485,7 @@ 
     /**
      * Load json files from dir.
      *
-     * @param $dir
+     * @param string $dir
      * @return \PragmaRX\Coollection\Package\Coollection
      */
     public function loadJsonFiles($dir)
@@ -566,7 +571,7 @@ 
     /**
      * Loads a json file.
      *
-     * @param $file
+     * @param string $file
      * @param string $dir
      * @return \PragmaRX\Coollection\Package\Coollection
      * @throws \Exception
@@ -603,7 +608,7 @@ 
     /**
      * Put contents into a file.
      *
-     * @param $file
+     * @param string $file
      * @param $contents
      */
     public function putFile($file, $contents)

src/update/Rinvex.php

Doc Comments +3 added lines, -3 removed lines

@@ -156,8 +156,8 @@ 
      * Merge country data with Rinvex data.
      *
      * @param Coollection $natural
-     * @param Coollection $rinvex
-     * @param $translation
+     * @param null|Coollection $rinvex
+     * @param null|Coollection $translation
      * @param string $suffix
      * @return mixed|\PragmaRX\Coollection\Package\Coollection
      */
@@ -259,7 +259,7 @@ 
     }
 
     /**
-     * @param \PragmaRX\Coollection\Package\Coollection $rinvex
+     * @param null|Coollection $rinvex
      * @param $cca3
      * @param $postal
      * @param $country

src/update/Updater.php

Doc Comments +4 added lines, -4 removed lines

@@ -125,7 +125,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return Command
      */
     public function getCommand()
     {
@@ -205,7 +205,7 @@ 
 
     /**
      * @param $result
-     * @param $type
+     * @param string $type
      * @return \PragmaRX\Coollection\Package\Coollection
      */
     public function addRecordType($result, $type)
@@ -244,7 +244,7 @@ 
      * @param \PragmaRX\Coollection\Package\Coollection $on
      * @param \PragmaRX\Coollection\Package\Coollection $by
      * @param $fields
-     * @param $codeField
+     * @param string $codeField
      * @return array
      */
     public function findByFields($on, $by, $fields, $codeField)
@@ -324,7 +324,7 @@ 
     /**
      * @param $result
      * @param $dir
-     * @param $normalizerClosure
+     * @param Closure $normalizerClosure
      * @return array
      */
     public function normalizeData($result, $dir, $normalizerClosure)