carono / film-janitor

src/Cli.php

Doc Comments +5 added lines, -5 removed lines

@@ -34,7 +34,7 @@ 
     }
 
     /**
-     * @param $dir
+     * @param string $dir
      */
     public static function reformFiles($dir)
     {
@@ -159,8 +159,8 @@ 
     }
 
     /**
-     * @param $name
-     * @return bool
+     * @param string $name
+     * @return string|false
      */
     public static function extractYear($name)
     {
@@ -175,8 +175,8 @@ 
     }
 
     /**
-     * @param null $season
-     * @param null $episode
+     * @param integer|null $season
+     * @param integer|null $episode
      * @return string
      */
     public static function getEpisodeName($season = null, $episode = null)

src/engines/EngineAbstract.php

Doc Comments +9 added lines, -9 removed lines

@@ -37,7 +37,7 @@ 
 
     /**
      * @param $name
-     * @return null
+     * @return string
      */
     public function getOptionDefaultValue($name)
     {
@@ -49,7 +49,7 @@ 
 
     /**
      * @param $name
-     * @return null
+     * @return string
      */
     public function getOptionDescription($name)
     {
@@ -60,8 +60,8 @@ 
     }
 
     /**
-     * @param $name
-     * @return array|false|null|string
+     * @param string $name
+     * @return null|string
      */
     public function getOption($name)
     {
@@ -92,7 +92,7 @@ 
     }
 
     /**
-     * @param $request
+     * @param string $request
      * @param $data
      */
     public static function setCacheValue($request, $data)
@@ -103,8 +103,8 @@ 
     }
 
     /**
-     * @param $request
-     * @return mixed
+     * @param string $request
+     * @return string
      */
     public static function getCacheValue($request)
     {
@@ -117,7 +117,7 @@ 
     }
 
     /**
-     * @param $text
+     * @param string $text
      * @return int|null
      */
     public function parseSerialSeason($text)
@@ -136,7 +136,7 @@ 
     }
 
     /**
-     * @param $text
+     * @param string $text
      * @return int|null
      */
     public function parseSerialEpisodeNumber($text)

src/File.php

Doc Comments +6 added lines

@@ -212,12 +212,18 @@
         return $this->engine->parseSerialSeason($this->filePath) ?: $this->engine->parseSerialSeason($this->getFolder());
     }
 
+    /**
+     * @param string $key
+     */
     protected function setCacheValue($key, $data)
     {
         $class = $this->engine;
         $class::setCacheValue($key, $data);
     }
 
+    /**
+     * @param string $key
+     */
     protected function getCacheValue($key)
     {
         $class = $this->engine;

src/helpers/ArrayHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
      * @param array $a array to be merged to
      * @param array $b array to be merged from. You can specify additional
      * arrays via third argument, fourth argument etc.
-     * @return array the merged array (the original arrays are not changed.)
+     * @return string the merged array (the original arrays are not changed.)
      */
     public static function merge($a, $b)
     {

src/helpers/Console.php

Doc Comments +6 added lines, -3 removed lines

@@ -454,7 +454,7 @@ 
      * - windows without ansicon
      * - not tty consoles
      *
-     * @param mixed $stream
+     * @param string $stream
      * @return bool true if the stream supports ANSI colors, otherwise false.
      */
     public static function streamSupportsAnsiColors($stream)
@@ -486,7 +486,7 @@ 
      * @param bool $refresh whether to force checking and not re-use cached size value.
      * This is useful to detect changing window size while the application is running but may
      * not get up to date values on every terminal.
-     * @return array|bool An array of ($width, $height) or false when it was not able to determine size.
+     * @return string An array of ($width, $height) or false when it was not able to determine size.
      */
     public static function getScreenSize($refresh = false)
     {
@@ -715,7 +715,7 @@ 
      *
      * @param string $message to print out before waiting for user input
      * @param bool $default this value is returned if no selection is made.
-     * @return bool whether user confirmed
+     * @return boolean|null whether user confirmed
      */
     public static function confirm($message, $default = false)
     {
@@ -737,6 +737,9 @@ 
         }
     }
 
+    /**
+     * @param string $prompt
+     */
     public static function selectBox($prompt, $items = [], $selected = [])
     {
         echo "\n" . $prompt . "\n\n";

src/helpers/FileHelper.php

Doc Comments +2 added lines, -2 removed lines

@@ -420,7 +420,7 @@ 
 
 
     /**
-     * @param $name
+     * @param string $name
      * @return string
      */
     public static function prepareFileName($name)
@@ -634,7 +634,7 @@ 
      * @param string $pattern
      * @param bool $caseSensitive
      * @throws InvalidArgumentException
-     * @return array with keys: (string) pattern, (int) flags, (int|bool) firstWildcard
+     * @return string with keys: (string) pattern, (int) flags, (int|bool) firstWildcard
      */
     private static function parseExcludePattern($pattern, $caseSensitive)
     {

src/JanitorCommand.php

Doc Comments +3 added lines

@@ -54,6 +54,9 @@
         $options->registerCommand(static::CMD_RESET_ENV, 'Reset env options');
     }
 
+    /**
+     * @param string $value
+     */
     protected function setEnvOption($option, $value)
     {
         $value = addcslashes($value, '"\\');