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/goals/ConfigGoal.php

Doc Comments +6 added lines

@@ -41,6 +41,9 @@ 
         return $this->hasItem($name) || class_exists($this->getGoalClass($name));
     }
 
+    /**
+     * @return string
+     */
     public function getGoalClass($name)
     {
         return $this->getItemConfig($name)['class'];
@@ -57,6 +60,9 @@ 
         return is_scalar($config) ? ['class' => $config] : (array) $config;
     }
 
+    /**
+     * @return string
+     */
     public static function goal2class($id, $name = null)
     {
         $id = $id ?: $name;

src/goals/DefaultGoal.php

Doc Comments +3 added lines

@@ -117,6 +117,9 @@
         return $result;
     }
 
+    /**
+     * @param string $actions
+     */
     public function runActions($actions)
     {
         foreach (Helper::ksplit($actions) as $action) {

src/goals/ReadmeGoal.php

Doc Comments +9 added lines

@@ -24,6 +24,9 @@ 
         return 'README';
     }
 
+    /**
+     * @param string $char
+     */
     public function renderH($title, $char)
     {
         $res = $title . "\n";
@@ -42,6 +45,9 @@ 
         return $this->renderH($title, '-');
     }
 
+    /**
+     * @param string $text
+     */
     public function renderText($text)
     {
         $text = trim($text);
@@ -66,6 +72,9 @@ 
         return $text ? "\n## $section\n\n$text\n" : '';
     }
 
+    /**
+     * @param string $file
+     */
     public function getSection($file, $default = null)
     {
         $view = Yii::$app->getView();

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);