danielgp / common-lib

source/CommonBasic.php

Doc Comments +8 added lines, -2 removed lines

@@ -63,6 +63,9 @@ 
         return $aDetails;
     }
 
+    /**
+     * @param string $fileGiven
+     */
     protected function getFileDetailsRawStatistic(\SplFileInfo $info, $fileGiven)
     {
         return [
@@ -81,6 +84,9 @@ 
         ];
     }
 
+    /**
+     * @param integer $timeAsPhpNumber
+     */
     private function getFileTimes($timeAsPhpNumber)
     {
         return [
@@ -94,7 +100,7 @@ 
      *
      * @param type $sourcePath
      * @param type $targetPath
-     * @return type
+     * @return string
      */
     protected function moveFilesIntoTargetFolder($sourcePath, $targetPath)
     {
@@ -210,7 +216,7 @@ 
     /**
      * Provides a list of all known JSON errors and their description
      *
-     * @return type
+     * @return null|string
      */
     protected function setJsonErrorInPlainEnglish()
     {

Spacing +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
             'Name'                   => $info->getRealPath(),
             'Type'                   => $info->getType(),
         ];
-        $aDetails          = array_merge($aFileBasicDetails, $this->getFileDetailsRawStatistic($info, $fileGiven));
+        $aDetails = array_merge($aFileBasicDetails, $this->getFileDetailsRawStatistic($info, $fileGiven));
         ksort($aDetails);
         return $aDetails;
     }
@@ -214,7 +214,7 @@ 
      */
     protected function setJsonErrorInPlainEnglish()
     {
-        $knownErrors  = [
+        $knownErrors = [
             JSON_ERROR_NONE           => null,
             JSON_ERROR_DEPTH          => 'Maximum stack depth exceeded',
             JSON_ERROR_STATE_MISMATCH => 'Underflow or the modes mismatch',