imanghafoori1 / laravel-microscope

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/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/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/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/Checks/ExtractBladePartial.php

Doc Comments +12 added lines

@@ -45,6 +45,9 @@ 
         return $tokens;
     }
 
+    /**
+     * @param string $name
+     */
     public static function find($name)
     {
         if (self::hasHintInformation($name = trim($name))) {
@@ -61,6 +64,9 @@ 
         }, ['blade.php']);
     }
 
+    /**
+     * @param string $name
+     */
     protected static function findNamespacedView($name)
     {
         [$namespace, $view] = self::parseNamespaceSegments($name);
@@ -95,11 +101,17 @@ 
         }
     }
 
+    /**
+     * @param string $name
+     */
     public static function hasHintInformation($name)
     {
         return strpos($name, '::') > 0;
     }
 
+    /**
+     * @param string $message
+     */
     public static function forceFilePutContents($filepath, $message){
         try {
             $isInFolder = preg_match("/^(.*)\/([^\/]+)$/", $filepath, $filepathMatches);

src/Commands/CheckRoutes.php

Doc Comments +3 added lines

@@ -60,6 +60,9 @@
         return 'Error on route '.$msg;
     }
 
+    /**
+     * @param ErrorPrinter $errorPrinter
+     */
     private function checkRouteDefinitions($errorPrinter, $routes)
     {
         foreach ($routes as $route) {

src/Commands/CheckEarlyReturns.php

Doc Comments +6 added lines

@@ -56,6 +56,9 @@ 
         return app(ErrorPrinter::class)->hasErrors() ? 1 : 0;
     }
 
+    /**
+     * @param integer $tries
+     */
     private function fix($filePath, $tokens, $tries)
     {
         Refactor::saveTokens($filePath, $tokens, $this->option('test'));
@@ -73,6 +76,9 @@ 
         return [$fixes, $tokens];
     }
 
+    /**
+     * @param integer $fixed
+     */
     private function printFinalMsg($fixed)
     {
         if ($fixed > 0) {

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/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('---------------------------------------------------');