hiqdev / hidev

src/controllers/GithubController.php

Doc Comments +5 added lines, -1 removed lines

@@ -113,7 +113,7 @@ 
     /**
      * Action to check 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)
     {
@@ -160,6 +160,10 @@ 
         return 0;
     }
 
+    /**
+     * @param string $method
+     * @param string $path
+     */
     public function request($method, $path, $data)
     {
         $url = 'https://api.github.com' . $path;

src/helpers/Helper.php

Doc Comments +9 added lines

@@ -19,11 +19,17 @@ 
  */
 class Helper
 {
+    /**
+     * @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);
@@ -70,6 +76,9 @@ 
         return array_combine($res, $res);
     }
 
+    /**
+     * @param string $subj
+     */
     public static function getPublicVars($subj)
     {
         return is_object($subj) ? get_object_vars($subj) : get_class_vars($subj);

src/handlers/BaseHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
      *
      * @param mixed $data
      *
-     * @return string file content
+     * @return boolean file content
      */
     public function renderPath($path, $data)
     {
@@ -156,7 +156,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/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/GettersTrait.php

Doc Comments +3 added lines

@@ -28,6 +28,9 @@
         return $this->_view;
     }
 
+    /**
+     * @param string $id
+     */
     public function take($id)
     {
         return $this->getApp()->get($id);

src/controllers/AbstractController.php

Doc Comments +3 added lines, -3 removed lines

@@ -47,7 +47,7 @@ 
     }
 
     /**
-     * @return int|Response exit code
+     * @return null|integer exit code
      */
     public function actionMake()
     {
@@ -141,7 +141,7 @@ 
     /**
      * Is response NOT Ok.
      * @param Response|int $res
-     * @return bool
+     * @return integer
      */
     public static function isNotOk($res)
     {
@@ -162,7 +162,7 @@ 
      * Runs list of actions.
      * TODO: think to redo with runRequests.
      * @param null|string|array $actions
-     * @return int|Response exit code
+     * @return null|integer exit code
      */
     public function runActions($actions)
     {

src/controllers/Collection.php

Doc Comments +3 added lines

@@ -58,6 +58,9 @@
         return $item;
     }
 
+    /**
+     * @param string $id
+     */
     public function getGoal($id)
     {
         return Yii::$app->createControllerById($id);

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;