hiqdev / hidev

src/base/Controller.php

Doc Comments +3 added lines

@@ -56,6 +56,9 @@
         return readline($prompt);
     }
 
+    /**
+     * @param string $prompt
+     */
     public function readpassword($prompt)
     {
         echo $prompt;

src/base/File.php

Doc Comments +13 added lines, -1 removed lines

@@ -88,7 +88,7 @@ 
 
     /**
      * Create file object.
-     * @param string|array $path or config
+     * @param string $path or config
      * @return File
      */
     public static function create($path)
@@ -144,6 +144,9 @@ 
         return $type2extension[$type];
     }
 
+    /**
+     * @param string $extension
+     */
     public function getTypeByExtension($extension)
     {
         return isset(static::$_extension2type[$extension]) ? static::$_extension2type[$extension] : null;
@@ -158,6 +161,9 @@ 
         return ($this->goal ? $this->goal->fileType : null) ?: static::getTypeByExtension($this->_extension) ?: 'template';
     }
 
+    /**
+     * @param string $path
+     */
     public function setPath($path)
     {
         $path             = Yii::getAlias($path);
@@ -234,6 +240,9 @@ 
         return $this->getHandler()->renderPath($this->getPath(), $this->data);
     }
 
+    /**
+     * @param string $content
+     */
     public function write($content)
     {
         return $this->getHandler()->write($this->getPath(), $content);
@@ -244,6 +253,9 @@ 
         return $this->data = $this->getHandler()->parsePath($this->getPath(), $this->getMinimalPath());
     }
 
+    /**
+     * @return string
+     */
     public function read()
     {
         return $this->getHandler()->read($this->getPath());

src/base/Starter.php

Doc Comments +7 added lines, -1 removed lines

@@ -233,7 +233,7 @@ 
     /**
      * Passthru command.
      * @param string $command
-     * @param array $args
+     * @param string[] $args
      * @return int exit code
      */
     private function passthru($command, $args)
@@ -299,6 +299,9 @@ 
         }
     }
 
+    /**
+     * @param string $value
+     */
     public function setRootDir($value)
     {
         $this->_rootDir = $value;
@@ -330,6 +333,9 @@ 
         throw new InvalidParamException("Not a hidev project (or any of the parent directories).\nUse `hidev init` to initialize hidev project.");
     }
 
+    /**
+     * @param string $subpath
+     */
     public function buildRootPath($subpath)
     {
         return $this->getRootDir() . DIRECTORY_SEPARATOR . $subpath;

src/components/Version.php

Doc Comments +3 added lines

@@ -103,6 +103,9 @@
         return $release ?: $this->release ?: 'dev';
     }
 
+    /**
+     * @param string $branch
+     */
     public function setBranch($branch, $release = null)
     {
         if (isset($branch) && $release !== 'dev') {

src/base/GettersTrait.php

Doc Comments +4 added lines, -1 removed lines

@@ -28,6 +28,9 @@ 
         return $this->_view;
     }
 
+    /**
+     * @param string $id
+     */
     public function take($id)
     {
         return $this->getApp()->get($id);
@@ -43,7 +46,7 @@ 
      * Command output passes unchanged to console.
      * Returns exit code.
      * @param string $name
-     * @param array|string $args
+     * @param string[] $args
      * @return int exit code
      */
     public function passthru($name, $args = [])

src/console/GithubController.php

Doc Comments +5 added lines, -1 removed lines

@@ -120,7 +120,7 @@ 
     /**
      * Checks if repo exists.
      * @param string $repo full name vendor/package defaults to this repo name
-     * @return int exit code
+     * @return boolean exit code
      */
     public function actionExists($repo = null)
     {
@@ -168,6 +168,10 @@ 
         return 0;
     }
 
+    /**
+     * @param string $method
+     * @param string $path
+     */
     public function request($method, $path, $data)
     {
         $url = 'https://api.github.com' . $path;

src/handlers/BaseHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -83,7 +83,7 @@ 
      * Renders file content using given data.
      * Converts to array with ArrayHelper::toArray.
      * @param mixed $data
-     * @return string file content
+     * @return boolean file content
      */
     public function renderPath($path, $data)
     {
@@ -132,7 +132,7 @@ 
      * Read file into a string or array.
      * @param string $path
      * @param bool $asArray
-     * @return string|array
+     * @return string
      */
     public function read($path, $asArray = false)
     {

src/helpers/Helper.php

Doc Comments +6 added lines

@@ -24,11 +24,17 @@
         return method_exists(Yii::class, 'autoload');
     }
 
+    /**
+     * @return string
+     */
     public static function bad2sep($str, $separator = '-')
     {
         return preg_replace('/[^a-zA-Z0-9-]/', $separator, $str);
     }
 
+    /**
+     * @param string $id
+     */
     public static function id2camel($id, $separator = '-')
     {
         return Inflector::id2camel(self::bad2sep($id, $separator), $separator);

src/console/InitController.php

Doc Comments +6 added lines

@@ -69,6 +69,9 @@ 
         );
     }
 
+    /**
+     * @param string|null $name
+     */
     public function prepareData($name)
     {
         $this->name = $name;
@@ -162,6 +165,9 @@ 
         return $this->title ?: Helper::titleize($this->package);
     }
 
+    /**
+     * @return string
+     */
     public function getKeywords()
     {
         return $this->keywords ?: implode(', ', explode('-', $this->package));