imanghafoori1 / laravel-microscope

src/ErrorReporters/ErrorPrinter.php

Doc Comments +10 added lines

@@ -53,6 +53,10 @@ 
         $this->pendError($absPath, $lineNumber, $relatedModel, 'badRelation', $header);
     }
 
+    /**
+     * @param string $key
+     * @param string $header
+     */
     public function pendError($path, $lineNumber, $absent, $key, $header)
     {
         array_push($this->counts[$key], (new PendingError($key))
@@ -89,6 +93,9 @@ 
             ->link($absPath, $lineNumber));
     }
 
+    /**
+     * @param integer $len
+     */
     public function print($msg, $path = '|  ', $len = null)
     {
         ! $len && $len = PendingError::$maxLength + 1;
@@ -104,6 +111,9 @@ 
         $this->printer->writeln($path.$msg.str_repeat(' ', $len).'|');
     }
 
+    /**
+     * @param string $msg
+     */
     public function printHeader($msg)
     {
         $this->print('');

src/Commands/CheckPsr4.php

Unused Use Statements +2 added lines, -2 removed lines

@@ -4,9 +4,9 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Support\Composer;
-use Imanghafoori\LaravelMicroscope\CheckNamespaces;
-use Imanghafoori\LaravelMicroscope\Analyzers\FilePath;
 use Imanghafoori\LaravelMicroscope\Analyzers\ComposerJson;
+use Imanghafoori\LaravelMicroscope\Analyzers\FilePath;
+use Imanghafoori\LaravelMicroscope\CheckNamespaces;
 use Imanghafoori\LaravelMicroscope\Contracts\FileCheckContract;
 use Imanghafoori\LaravelMicroscope\ErrorReporters\ErrorPrinter;
 use Imanghafoori\LaravelMicroscope\Traits\LogsErrors;

Doc Comments +4 added lines, -1 removed lines

@@ -37,7 +37,7 @@ 
      *
      * @param  ErrorPrinter  $errorPrinter
      *
-     * @return mixed
+     * @return integer
      */
     public function handle(ErrorPrinter $errorPrinter)
     {
@@ -57,6 +57,9 @@ 
         return app(ErrorPrinter::class)->hasErrors() ? 1 : 0;
     }
 
+    /**
+     * @param ErrorPrinter $errorPrinter
+     */
     private function composerDumpIfNeeded($errorPrinter)
     {
         if ($errorPrinter->counts['badNamespace']) {

src/Analyzers/FunctionCall.php

Doc Comments +9 added lines

@@ -16,6 +16,9 @@ 
         return [$nextToken, $i];
     }
 
+    /**
+     * @param string[] $tokenType
+     */
     public static function forwardTo($tokens, $i, $tokenType)
     {
         $i++;
@@ -46,6 +49,9 @@ 
         return ($tokens[0][0] == T_CONSTANT_ENCAPSED_STRING) && ($nextToken !== '.');
     }
 
+    /**
+     * @param string $funcName
+     */
     public static function isGlobalCall($funcName, &$tokens, $i)
     {
         $expectedTokens = [
@@ -80,6 +86,9 @@ 
         return self::checkTokens($expectedTokens, $tokens, $i);
     }
 
+    /**
+     * @param string $methodName
+     */
     public static function isMethodCallOnThis($methodName, &$tokens, $i)
     {
         $expectedTokens = [

src/Refactors/EarlyReturns.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace Imanghafoori\LaravelMicroscope\Refactors;
 
-use Imanghafoori\LaravelMicroscope\Analyzers\Refactor;
 use Imanghafoori\LaravelMicroscope\Analyzers\FunctionCall;
+use Imanghafoori\LaravelMicroscope\Analyzers\Refactor;
 
 class EarlyReturns
 {

Doc Comments +3 added lines

@@ -71,6 +71,9 @@
         return [$tokens, $changes];
     }
 
+    /**
+     * @return string
+     */
     private static function getKeyword($token)
     {
         return self::scopeKeywords[$token];

src/Refactors/IfElse.php

Doc Comments +4 added lines

@@ -20,6 +20,10 @@
         }
     }
 
+    /**
+     * @param integer $elseCount
+     * @param integer $ifBody
+     */
     private static function shouldBeFlipped($elseCount, $ifBody)
     {
         $ifIsLonger = ($elseCount + 10) < $ifBody;

src/Refactors/SyntaxNormalizer.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace Imanghafoori\LaravelMicroscope\Refactors;
 
-use Imanghafoori\LaravelMicroscope\Analyzers\Ifs;
 use Imanghafoori\LaravelMicroscope\Analyzers\FunctionCall;
+use Imanghafoori\LaravelMicroscope\Analyzers\Ifs;
 
 class SyntaxNormalizer
 {

src/Analyzers/Refactor.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
         return $stringOutput;
     }
 
+    /**
+     * @param \Closure $refactor
+     */
     private static function recursiveRefactor($tokens, $refactor)
     {
         $i = $changes = 0;

src/CheckNamespaces.php

Doc Comments +11 added lines, -2 removed lines

@@ -14,10 +14,10 @@ 
     /**
      * Get all of the listeners and their corresponding events.
      *
-     * @param  iterable  $paths
+     * @param  \Symfony\Component\Finder\Finder  $paths
      * @param  $composerPath
      * @param  $composerNamespace
-     * @param  $command
+     * @param  Commands\CheckPsr4 $command
      *
      * @return void
      */
@@ -72,6 +72,9 @@ 
         }
     }
 
+    /**
+     * @param string $relativePath
+     */
     private static function warn($currentNamespace, $relativePath)
     {
         $p = app(ErrorPrinter::class);
@@ -93,6 +96,9 @@ 
         return Str::startsWith($buffer, '<?php');
     }
 
+    /**
+     * @param string $correctNamespace
+     */
     protected static function doNamespaceCorrection($absFilePath, $currentNamespace, $correctNamespace)
     {
         event('laravel_microscope.namespace_fixing', get_defined_vars());
@@ -100,6 +106,9 @@ 
         event('laravel_microscope.namespace_fixed', get_defined_vars());
     }
 
+    /**
+     * @param string $correctNamespace
+     */
     private static function ask($command, $correctNamespace)
     {
         return $command->getOutput()->confirm('Do you want to change it to: '.$correctNamespace, true);

Unused Use Statements +1 added lines, -1 removed lines

@@ -4,10 +4,10 @@
 
 use Illuminate\Support\Str;
 use Imanghafoori\LaravelMicroscope\Analyzers\FilePath;
-use Imanghafoori\LaravelMicroscope\LaravelPaths\MigrationPaths;
 use Imanghafoori\LaravelMicroscope\Analyzers\GetClassProperties;
 use Imanghafoori\LaravelMicroscope\Analyzers\NamespaceCorrector;
 use Imanghafoori\LaravelMicroscope\ErrorReporters\ErrorPrinter;
+use Imanghafoori\LaravelMicroscope\LaravelPaths\MigrationPaths;
 
 class CheckNamespaces
 {

src/CheckClasses.php

Doc Comments +3 added lines

@@ -26,6 +26,9 @@
         }
     }
 
+    /**
+     * @param string $msg
+     */
     public static function warnDumping($msg)
     {
         $p = resolve(ErrorPrinter::class)->printer;

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace Imanghafoori\LaravelMicroscope;
 
-use Illuminate\Support\Str;
 use Illuminate\Support\Composer;
+use Illuminate\Support\Str;
 use Imanghafoori\LaravelMicroscope\Analyzers\GetClassProperties;
 use Imanghafoori\LaravelMicroscope\Analyzers\ParseUseStatement;
 use Imanghafoori\LaravelMicroscope\ErrorReporters\ErrorPrinter;