hiqdev / hidev

src/base/File.php

Doc Comments +6 added lines

@@ -109,6 +109,9 @@ 
         return $type2extension[$type];
     }
 
+    /**
+     * @param string $extension
+     */
     public function getTypeByExtension($extension)
     {
         return static::$_extension2type[$extension];
@@ -119,6 +122,9 @@ 
         return ($this->goal ? $this->goal->fileType : null) ?: static::getTypeByExtension($this->_extension) ?: 'template';
     }
 
+    /**
+     * @param string $path
+     */
     public function setPath($path)
     {
         $path             = Yii::getAlias($path);

Spacing +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
      */
     protected static $_extension2type = [
         'json'      => 'json',
-        'yml'       => 'yaml',  /// first one is preferred
+        'yml'       => 'yaml', /// first one is preferred
         'yaml'      => 'yaml',
         'xml'       => 'xml',
         'xml.dist'  => 'xml',

src/base/History.php

Doc Comments +13 added lines

@@ -65,18 +65,28 @@ 
         $this->_commit = $commit;
     }
 
+    /**
+     * @param string $label
+     */
     public function addTag($tag, $label)
     {
         $this->tag                         = $tag;
         $this->_history[$this->tag]['tag'] = $label ?: $tag;
     }
 
+    /**
+     * @param string $note
+     */
     public function addNote($note, $label = null)
     {
         $this->note                                = $note;
         $this->_history[$this->tag][$note]['note'] = $label ?: $note;
     }
 
+    /**
+     * @param string $commit
+     * @param string $label
+     */
     public function addCommit($commit, $label)
     {
         $this->commit            = $commit;
@@ -171,6 +181,9 @@ 
         return $res;
     }
 
+    /**
+     * @param string $key
+     */
     public function arrayPop(&$array, $key)
     {
         $res = $array[$key];

src/handlers/CommitsHandler.php

Doc Comments +16 added lines

@@ -59,6 +59,9 @@ 
         $this->_hash = $hash;
     }
 
+    /**
+     * @param string $label
+     */
     public function addTag($tag, $label = null)
     {
         $this->tag = $tag;
@@ -66,6 +69,9 @@ 
         $ref       = $label ?: $ref ?: $tag;
     }
 
+    /**
+     * @param string $note
+     */
     public function addNote($note, $label = null)
     {
         $this->note = $note;
@@ -73,6 +79,10 @@ 
         $ref        = $label ?: $ref ?: $note;
     }
 
+    /**
+     * @param string $hash
+     * @param string $label
+     */
     public function addHash($hash, $label)
     {
         $this->_hash                    = $hash;
@@ -183,6 +193,9 @@ 
         return $res;
     }
 
+    /**
+     * @param string $key
+     */
     public static function arrayPop(&$array, $key)
     {
         $res = $array[$key];
@@ -239,6 +252,9 @@ 
         return $date ? date(' Y-m-d', strtotime($date)) : '';
     }
 
+    /**
+     * @param string $string
+     */
     public static function renderHeader($string)
     {
         $header = Yii::$app->config->package->fullName . ' ' . $string;

src/helpers/Helper.php

Doc Comments +6 added lines

@@ -19,6 +19,9 @@ 
  */
 class Helper
 {
+    /**
+     * @return string
+     */
     public static function bad2sep($str, $separator = '-')
     {
         return preg_replace('/[^a-zA-Z0-9-]/', $separator, $str);
@@ -70,6 +73,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 +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
      *
      * @param mixed $data
      *
-     * @return string file content
+     * @return boolean file content
      */
     public function renderPath($path, $data)
     {

src/base/Application.php

Doc Comments -1 removed lines

@@ -68,7 +68,6 @@
 
     /**
      * Load extra config files.
-     * @param array $config
      * @return void
      */
     public function loadExtraVendor($dir)

Unused Use Statements -1 removed lines

@@ -13,7 +13,6 @@
 
 use Exception;
 use Yii;
-use yii\base\InvalidConfigException;
 use yii\base\InvalidParamException;
 use yii\console\Exception as ConsoleException;
 use yii\base\Module;

src/components/Config.php

Doc Comments +3 added lines

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

Unused Use Statements -3 removed lines

@@ -12,10 +12,7 @@
 namespace hidev\components;
 
 use hidev\base\File;
-use hidev\helpers\Helper;
 use Yii;
-use yii\base\BootstrapInterface;
-use yii\base\InvalidParamException;
 use yii\helpers\ArrayHelper;
 
 /**

src/controllers/AbstractController.php

Doc Comments +4 added lines, -1 removed lines

@@ -139,7 +139,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)
     {
@@ -199,6 +199,9 @@ 
         return Yii::$app->get('binaries')->passthru($name, $args);
     }
 
+    /**
+     * @param string $id
+     */
     public function takeGoal($id)
     {
         return Yii::$app->get('config')->getGoal($id);

Spacing +2 added lines, -2 removed lines

@@ -96,11 +96,11 @@
         if (!$tasks) {
             return [];
         } elseif (!is_array($tasks)) {
-            $tasks = [(string)$tasks => 1];
+            $tasks = [(string) $tasks => 1];
         }
         $res = [];
         foreach ($tasks as $dep => $enabled) {
-            $res[(string)(is_int($dep) ? $enabled : $dep)] = (bool)(is_int($dep) ? 1 : $enabled);
+            $res[(string) (is_int($dep) ? $enabled : $dep)] = (bool) (is_int($dep) ? 1 : $enabled);
         }
 
         return $res;

src/controllers/CommonController.php

Unused Use Statements -1 removed lines

@@ -12,7 +12,6 @@
 namespace hidev\controllers;
 
 use Yii;
-use hidev\helpers\Helper;
 
 /**
  * Common controller.