antonioribeiro / countries

src/update/Helper.php

Doc Comments +18 added lines, -13 removed lines

@@ -69,9 +69,9 @@ 
     /**
      * Add suffix to string.
      *
-     * @param $suffix
-     * @param $string
-     * @return mixed
+     * @param string string
+     * @param string $string
+     * @return string
      */
     protected function addSuffix($suffix, $string)
     {
@@ -98,7 +98,7 @@ 
     /**
      * Delete a whole directory.
      *
-     * @param $dir
+     * @param string $dir
      */
     protected function deleteDirectory($dir)
     {
@@ -116,6 +116,11 @@ 
         rmdir($dir);
     }
 
+    /**
+     * @param string $string
+     *
+     * @return resource
+     */
     protected function fopenOrFail($url, $string)
     {
         if (($handle = @fopen($url, $string)) === false) {
@@ -184,7 +189,7 @@ 
 
     /**
      * @param $url
-     * @param $destination
+     * @param string $destination
      */
     public function downloadFile($url, $destination)
     {
@@ -255,8 +260,8 @@ 
     /**
      * @param $file
      * @param $subPath
-     * @param $path
-     * @param $exclude
+     * @param string $path
+     * @param string $exclude
      */
     protected function renameMasterToPackage($file, $subPath, $path, $exclude)
     {
@@ -310,8 +315,8 @@ 
     /**
      * Load a shapeFile.
      *
-     * @param $dir
-     * @return \PragmaRX\Coollection\Package\Coollection
+     * @param string $dir
+     * @return string
      */
     public function shapeFile($dir)
     {
@@ -391,7 +396,7 @@ 
      * Unzip a file.
      *
      * @param $file
-     * @param $path
+     * @param string $path
      */
     public function unzip($file, $path)
     {
@@ -483,7 +488,7 @@ 
     /**
      * Load json files from dir.
      *
-     * @param $dir
+     * @param string $dir
      * @return \PragmaRX\Coollection\Package\Coollection
      */
     public function loadJsonFiles($dir)
@@ -569,7 +574,7 @@ 
     /**
      * Loads a json file.
      *
-     * @param $file
+     * @param string $file
      * @param string $dir
      * @return \PragmaRX\Coollection\Package\Coollection
      * @throws \Exception
@@ -606,7 +611,7 @@ 
     /**
      * Put contents into a file.
      *
-     * @param $file
+     * @param string $file
      * @param $contents
      */
     public function putFile($file, $contents)