imanghafoori1 / laravel-microscope

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/EarlyReturns.php

Doc Comments +3 added lines

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

src/SpyClasses/SpyDispatcher.php

Doc Comments +12 added lines

@@ -59,6 +59,9 @@ 
         return class_exists($eventName, false) ? $this->addOriginInterfaceListeners($eventName, $listeners) : $listeners;
     }
 
+    /**
+     * @param string $string
+     */
     private function error($string)
     {
         $len = strlen($string);
@@ -95,6 +98,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     private function stringify($event)
     {
         return is_object($event) ? get_class($event) : $event;
@@ -116,6 +122,9 @@ 
         return 'The method of '.$at.' is not callable as an event listener for "'.$e.'" event';
     }
 
+    /**
+     * @return string
+     */
     protected function getTypeHintedClass($listenerObj, $methodName)
     {
         try {
@@ -141,6 +150,9 @@ 
         return $listeners;
     }
 
+    /**
+     * @param \Closure $listener
+     */
     private function stringifyClosure($listener)
     {
         try {

src/Checks/ActionsComments.php

Doc Comments +6 added lines

@@ -28,6 +28,9 @@ 
         }
     }
 
+    /**
+     * @param string $fullNamespace
+     */
     protected static function checkActions($tokens, $fullNamespace, $path)
     {
         $class = ClassMethods::read($tokens);
@@ -73,6 +76,9 @@ 
         return $routelessActions;
     }
 
+    /**
+     * @param \Illuminate\Routing\Route $route
+     */
     protected static function getMsg($methods, $route)
     {
         $msg = '/**'."\n";

src/Analyzers/FunctionCall.php

Doc Comments +9 added lines

@@ -16,6 +16,9 @@ 
         return [$token, $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/Checks/ExtractBladePartial.php

Doc Comments +12 added lines

@@ -72,6 +72,9 @@ 
         return $tokens;
     }
 
+    /**
+     * @param string $name
+     */
     public static function find($name)
     {
         if (self::hasHintInformation($name = \trim($name))) {
@@ -88,6 +91,9 @@ 
         }, ['blade.php']);
     }
 
+    /**
+     * @param string $name
+     */
     protected static function findNamespacedView($name)
     {
         [$namespace, $view] = self::parseNamespaceSegments($name);
@@ -122,11 +128,17 @@ 
         }
     }
 
+    /**
+     * @param string $name
+     */
     public static function hasHintInformation($name)
     {
         return strpos($name, '::') > 0;
     }
 
+    /**
+     * @param string $message
+     */
     public static function forceFilePutContents($filepath, $message)
     {
         try {

src/Commands/PrettyPrintRoutes.php

Doc Comments +19 added lines

@@ -35,6 +35,9 @@ 
         }
     }
 
+    /**
+     * @param \Illuminate\Routing\Route $route
+     */
     private function writeIt($route, $filename)
     {
         try {
@@ -57,6 +60,9 @@ 
         }
     }
 
+    /**
+     * @param string $value
+     */
     private function deduceRoute($value)
     {
         if (Str::containsAll($value, ['@', '\\'])) {
@@ -68,6 +74,9 @@ 
         return $route;
     }
 
+    /**
+     * @param \Illuminate\Routing\Route $route
+     */
     private function printIt($route)
     {
         try {
@@ -80,6 +89,10 @@ 
         }
     }
 
+    /**
+     * @param string $action
+     * @param string $middlewareSection
+     */
     private function getMovableRoute($route, $methods, $action, $middlewareSection)
     {
         if ($action == '\Illuminate\Routing\ViewController::class') {
@@ -117,6 +130,9 @@ 
         return $middlewares ? '->middleware(['.$middlewares.'])' : '';
     }
 
+    /**
+     * @param Exception $e
+     */
     private function handleRouteProblem($e)
     {
         $this->info('The route has some problem.');
@@ -124,6 +140,9 @@ 
         $this->info($e->getFile());
     }
 
+    /**
+     * @param string $middlewares
+     */
     private function prettyPrintInConsole($route, $middlewares)
     {
         $this->getOutput()->writeln('---------------------------------------------------');

src/ErrorReporters/ConsolePrinterInstaller.php

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

@@ -6,9 +6,9 @@
 use Illuminate\Support\Str;
 use Imanghafoori\LaravelMicroscope\ErrorTypes\BladeFile;
 use Imanghafoori\LaravelMicroscope\ErrorTypes\CompactCall;
-use Imanghafoori\LaravelMicroscope\ErrorTypes\ddFound;
 use Imanghafoori\LaravelMicroscope\ErrorTypes\EnvFound;
 use Imanghafoori\LaravelMicroscope\ErrorTypes\RouteDefinitionConflict;
+use Imanghafoori\LaravelMicroscope\ErrorTypes\ddFound;
 
 class ConsolePrinterInstaller
 {

Doc Comments +7 added lines

@@ -45,6 +45,9 @@ 
         $errorPrinter->printTime();
     }
 
+    /**
+     * @param string $commandType
+     */
     protected static function getKey($commandType)
     {
         return "__microscope__$commandType-count";
@@ -115,6 +118,10 @@ 
         });
     }
 
+    /**
+     * @param string $commandType
+     * @param integer $errorCount
+     */
     protected static function printErrorCount($lastTimeCount, $commandType, $errorCount)
     {
         $lastTimeError = $commandType.' errors, compared to the last run.';

src/GenerateCode.php

Doc Comments +13 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\CheckExpansions $command
      *
      * @return void
      */
@@ -69,6 +69,9 @@ 
         return $path;
     }
 
+    /**
+     * @param string $name
+     */
     private static function ask($command, $name)
     {
         return $command->getOutput()->confirm('Do you want to generate a service provider: '.$name, true);
@@ -83,6 +86,9 @@ 
             \in_array(T_DOUBLE_ARROW, [$tokens[$i + 1][0], $tokens[$i + 2][0]]);
     }
 
+    /**
+     * @param string $providerPath
+     */
     private static function addToProvidersArray($providerPath)
     {
         $tokens = token_get_all(file_get_contents(config_path('app.php')));
@@ -107,6 +113,11 @@ 
         return $tokens;
     }
 
+    /**
+     * @param \Symfony\Component\Finder\SplFileInfo $classFilePath
+     * @param string $namespace
+     * @param string $prefix
+     */
     protected static function generateFolderStructure($classFilePath, $namespace, $prefix)
     {
         $_basePath = $classFilePath->getPath().DIRECTORY_SEPARATOR;