hiqdev / hidev

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;

Spacing +3 added lines, -3 removed lines

@@ -212,7 +212,7 @@ 
     {
         $res = implode("\n", array_filter($lines));
 
-        return $res ? $res . "\n" : '';
+        return $res ? $res."\n" : '';
     }
 
     public static function renderCommit($commit)
@@ -262,9 +262,9 @@ 
 
     public static function renderHeader($string)
     {
-        $header = Yii::$app->config->package->fullName . ' ' . $string;
+        $header = Yii::$app->config->package->fullName.' '.$string;
 
-        return $header . "\n" . str_repeat('-', mb_strlen($header, Yii::$app->charset)) . "\n";
+        return $header."\n".str_repeat('-', mb_strlen($header, Yii::$app->charset))."\n";
     }
 
     public static function getVcs()

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

src/base/Application.php

Doc Comments +3 added lines, -1 removed lines

@@ -69,7 +69,6 @@ 
 
     /**
      * Load extra config files.
-     * @param array $config
      * @return void
      */
     public function loadExtraVendor($dir)
@@ -134,6 +133,9 @@ 
         return $controller;
     }
 
+    /**
+     * @param string $string
+     */
     public function runRequest($string)
     {
         $request = Yii::createObject([

Spacing +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
 
     public static function readExtraVendor($dir)
     {
-        return static::readExtraConfig($dir . '/hiqdev/hidev-config.php');
+        return static::readExtraConfig($dir.'/hiqdev/hidev-config.php');
     }
 
     public static function readExtraConfig($path)

src/base/File.php

Doc Comments +12 added lines

@@ -122,6 +122,9 @@ 
         return $type2extension[$type];
     }
 
+    /**
+     * @param string $extension
+     */
     public function getTypeByExtension($extension)
     {
         return static::$_extension2type[$extension];
@@ -132,6 +135,9 @@ 
         return ($this->goal ? $this->goal->fileType : null) ?: static::getTypeByExtension($this->_extension) ?: 'template';
     }
 
+    /**
+     * @param string $path
+     */
     public function setPath($path)
     {
         $path             = Yii::getAlias($path);
@@ -208,6 +214,9 @@ 
         return $this->handler->renderPath($this->path, $this->data);
     }
 
+    /**
+     * @param string $content
+     */
     public function write($content)
     {
         return $this->handler->write($this->path, $content);
@@ -218,6 +227,9 @@ 
         return $this->data = $this->handler->parsePath($this->path, $this->minimalPath);
     }
 
+    /**
+     * @return string
+     */
     public function read()
     {
         return $this->handler->read($this->path);

Spacing +7 added lines, -7 removed lines

@@ -109,7 +109,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',
@@ -158,7 +158,7 @@ 
 
     public function setBasename($basename)
     {
-        $this->setPath($this->_dirname . '/' . $basename);
+        $this->setPath($this->_dirname.'/'.$basename);
     }
 
     public function getBasename()
@@ -168,7 +168,7 @@ 
 
     public function setDirname($dirname)
     {
-        $this->setPath($dirname . '/' . $this->_basename);
+        $this->setPath($dirname.'/'.$this->_basename);
     }
 
     public function getDirname()
@@ -178,7 +178,7 @@ 
 
     public function setFilename($filename)
     {
-        $this->setPath($this->_dirname . '/' . $filename . '.' . $this->_extension);
+        $this->setPath($this->_dirname.'/'.$filename.'.'.$this->_extension);
     }
 
     public function getFilename()
@@ -188,7 +188,7 @@ 
 
     public function setExtension($extension)
     {
-        $this->setPath($this->_dirname . '/' . $this->_filename . '.' . $extension);
+        $this->setPath($this->_dirname.'/'.$this->_filename.'.'.$extension);
     }
 
     public function getExtension()
@@ -239,7 +239,7 @@ 
     {
         if (!is_object($this->_handler)) {
             $this->_handler = Yii::createObject([
-                'class'    => 'hidev\handlers\\' . $this->getCtype() . 'Handler',
+                'class'    => 'hidev\handlers\\'.$this->getCtype().'Handler',
                 'template' => $this->template,
                 'goal'     => $this->goal,
             ]);
@@ -336,7 +336,7 @@ 
 
     public function chown($value)
     {
-        $ownergroup = $this->getOwner() . ':' . $this->getGroup();
+        $ownergroup = $this->getOwner().':'.$this->getGroup();
         if (in_array($value, [$ownergroup, $this->getOwner(), $this->getUid()], false)) {
             return;
         }

src/controllers/FileController.php

Spacing +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
  */
 class FileController extends CollectionController
 {
-    protected $_make   = ['load', 'save', 'modify'];
+    protected $_make = ['load', 'save', 'modify'];
 
     /**
      * @var string specifies handler to be used

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;

Spacing +7 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
 
     public function getFull_name()
     {
-        return $this->getVendor() . '/' . $this->getName();
+        return $this->getVendor().'/'.$this->getName();
     }
 
     public function setFullName($value)
@@ -95,7 +95,7 @@ 
      */
     public function actionCreate()
     {
-        $res = $this->request('POST', '/orgs/' . $this->getVendor() . '/repos', [
+        $res = $this->request('POST', '/orgs/'.$this->getVendor().'/repos', [
             'name'        => $this->getName(),
             'description' => $this->getDescription(),
         ]);
@@ -114,7 +114,7 @@ 
      */
     public function actionClone($repo)
     {
-        return $this->passthru('git', ['clone', 'git@github.com:' . $repo]);
+        return $this->passthru('git', ['clone', 'git@github.com:'.$repo]);
     }
 
     /**
@@ -134,7 +134,7 @@ 
      */
     public static function exists($repo)
     {
-        return !static::exec('git', ['ls-remote', 'git@github.com:' . $repo], true);
+        return !static::exec('git', ['ls-remote', 'git@github.com:'.$repo], true);
     }
 
     public function actionRelease($version = null)
@@ -148,7 +148,7 @@ 
             return $wait;
         }
 
-        return $this->request('POST', '/repos/' . $this->getFull_name() . '/releases', [
+        return $this->request('POST', '/repos/'.$this->getFull_name().'/releases', [
             'tag_name'  => $version,
             'name'      => $version,
             'body'      => $notes,
@@ -169,9 +169,9 @@ 
 
     public function request($method, $path, $data)
     {
-        $url = 'https://api.github.com' . $path;
+        $url = 'https://api.github.com'.$path;
 
-        return $this->passthru('curl', ['-X', $method, '-H', 'Authorization: token ' . $this->getToken(), '--data', Json::encode($data), $url]);
+        return $this->passthru('curl', ['-X', $method, '-H', 'Authorization: token '.$this->getToken(), '--data', Json::encode($data), $url]);
     }
 
     public function findToken()

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

Spacing +4 added lines, -4 removed lines

@@ -126,7 +126,7 @@ 
         if (!is_file($path) || file_get_contents($path) !== $content) {
             $this->mkdir(dirname($path));
             file_put_contents($path, $content);
-            Yii::warning('Written file: ' . $path, 'file');
+            Yii::warning('Written file: '.$path, 'file');
 
             return true;
         }
@@ -144,7 +144,7 @@ 
         $path = trim(trim($path), '/');
         if (!file_exists($path)) {
             mkdir($path, 0777, true);
-            Yii::warning('Created dir:  ' . $path . '/', 'file');
+            Yii::warning('Created dir:  '.$path.'/', 'file');
 
             return true;
         }
@@ -161,11 +161,11 @@ 
     public function read($path, $asArray = false)
     {
         if (file_exists($path)) {
-            Yii::info('Read file: ' . $path, 'file');
+            Yii::info('Read file: '.$path, 'file');
 
             return $asArray ? file($path) : file_get_contents($path);
         } else {
-            Yii::error('Couldn\'t read file: ' . $path, 'file');
+            Yii::error('Couldn\'t read file: '.$path, 'file');
 
             return;
         }

src/controllers/AbstractController.php

Doc Comments +10 added lines, -4 removed lines

@@ -48,7 +48,7 @@ 
     }
 
     /**
-     * @return int|Response exit code
+     * @return null|integer exit code
      */
     public function actionMake()
     {
@@ -142,7 +142,7 @@ 
     /**
      * Is response NOT Ok.
      * @param Response|int $res
-     * @return bool
+     * @return integer
      */
     public static function isNotOk($res)
     {
@@ -151,7 +151,7 @@ 
 
     /**
      * Is response Ok.
-     * @param Response|int $res
+     * @param integer $res
      * @return bool
      */
     public static function isOk($res)
@@ -163,7 +163,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)
     {
@@ -240,6 +240,9 @@ 
         return readline($prompt);
     }
 
+    /**
+     * @param string $prompt
+     */
     public function readpassword($prompt)
     {
         echo $prompt;
@@ -250,6 +253,9 @@ 
         return $password;
     }
 
+    /**
+     * @param string $id
+     */
     public static function takeGoal($id)
     {
         return Yii::$app->get('config')->getGoal($id);