Apply fixes from StyleCI (#23)

api/components/ErrorHandler.php

@@ -28,33 +28,33 @@ protected function renderException($exception)
         } else {
             $response = new Response();
         }
-        
+
         //force return json format exception
         $response->format = Response::FORMAT_JSON;
         // if ($exception instanceof SystemException) {
-        
+
         //     $response->send();
         // }
         $response->data = $this->convertExceptionToArray($exception);
-        
+
         if ($exception instanceof HttpException) {
             $response->setStatusCode($exception->statusCode);
         } else {
             $response->setStatusCode(500);
         }
-        
+
         $response->send();
     }
-    
+
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     protected function convertExceptionToArray($exception)
     {
         if (!YII_DEBUG && !$exception instanceof UserException && !$exception instanceof HttpException) {
             $exception = new HttpException(500, 'There was an error at the server.');
         }
-        
+
         $array = [
             // 'name' => $exception->getName() ?: 'Exception',
             'errmsg' => $exception->getMessage(),
@@ -77,7 +77,7 @@ protected function convertExceptionToArray($exception)
                 $array['data']['previous'] = $this->convertExceptionToArray($prev);
             }
         }
-        
+
         return $array;
     }
 }

api/components/Setup.php

@@ -12,7 +12,7 @@
 class Setup implements BootstrapInterface
 {
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function bootstrap($app)
     {

api/components/behaviors/FormatResponseBehavior.php

@@ -2,7 +2,6 @@
 
 namespace api\components\behaviors;
 
-use Yii;
 use yii\base\Behavior;
 use yii\web\Response;
 
@@ -20,9 +19,9 @@ public function events()
             Response::EVENT_BEFORE_SEND => 'formatResponse',
         ];
     }
-    
+
     /**
-     * @param  \yii\base\Event $event
+     * @param \yii\base\Event $event
      */
     public function formatResponse($event)
     {
@@ -32,7 +31,6 @@ public function formatResponse($event)
         $headers->set('Access-Control-Allow-Origin', '*');
         //format response
         if ('html' !== $response->format) {
-
             if (!isset($response->data['errcode'])) {
                 if ($response->data !== null) {
                     $response->data = [

api/config/i18n.php

@@ -41,7 +41,7 @@
         '/messages',
         '/runtime',
         '.md',
-        '/config'
+        '/config',
     ],
 
     // 'php' output format is for saving messages to php files.

api/config/main.php

@@ -77,4 +77,3 @@
         require(__DIR__ . '/params.php')
     ),
 ];
-

api/controllers/SiteController.php

@@ -11,12 +11,12 @@ class SiteController extends Controller
 {
     use MethodInjectionTrait;
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public $enableCsrfValidation = false;
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function actions()
     {
@@ -38,16 +38,18 @@ public function actions()
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function beforeAction($action)
     {
         if (parent::beforeAction($action)) {
-            if ('api' == $action->id) {
+            if ('api' === $action->id) {
                 app()->response->detachBehavior('beforeSend');
             }
+
             return true;
         }
+
         return false;
     }
 
@@ -60,6 +62,7 @@ public function actionCreate()
     {
         app()->response->format = \yii\web\Response::FORMAT_JSON;
         $resutl = app()->request->bodyParams;
+
         return ['tr' => $resutl, 'xx' => app()->request->post(), 'get' => app()->request->get()];
     }
 

api/controllers/TestController.php

@@ -14,6 +14,7 @@ public function actionIndex()
     public function actionCreate()
     {
         $result = app()->request->bodyParams;
+
         return [
             'body' => $result,
             'post' => app()->request->post(),

api/modules/v1/Module.php

@@ -4,31 +4,27 @@
 
 use Yii;
 
-/**
- *
- * @package api\modules\v1
- */
 final class Module extends \yii\base\Module
 {
     public $controllerNamespace = 'api\modules\v1\controllers';
-    
+
     public function init()
     {
         parent::init();
-        
+
         //Yii::$app->getUser()->identityClass = 'api\modules\v1\models\User';
-        
+
         //finder model classes
         //$this->initFinderModelClass();
     }
-    
+
     /**
-     * Init finder model class
+     * Init finder model class.
      */
     protected function initFinderModelClass()
     {
         $container = Yii::$container;
-        
+
         //$container->set(TweetFinder::class, ['modelClass' => 'api\modules\v1\models\Tweet']);
     }
 }

api/modules/v1/controllers/AuthController.php

@@ -97,7 +97,6 @@
  *    ),
  *    @SWG\Response(response = 200, description = "success")
  * )
- *
  */
 class AuthController extends Controller
 {
@@ -108,6 +107,7 @@ public function behaviors()
     {
         $behaviors = parent::behaviors();
         unset($behaviors['authenticator']);
+
         return $behaviors;
     }
 
@@ -122,6 +122,7 @@ public function actions()
                 'phoneCheckCallback' => function ($tel) {
                     if (User::checkPhoneIsRegisted($tel)) {
                         $this->sendFaildValidation(t('app', '{phone} had been registed.', ['phone' => $tel]));
+
                         return false;
                     }
                 },
@@ -131,6 +132,7 @@ public function actions()
                 'phoneCheckCallback' => function ($tel) {
                     if (!User::checkPhoneIsRegisted($tel)) {
                         $this->sendFaildValidation(t('app', '{phone} has not registed.', ['phone' => $tel]));
+
                         return false;
                     }
                 },
@@ -149,6 +151,7 @@ public function actions()
                     }
                     $user->generatePasswordResetToken();
                     $user->update();
+
                     return $user->password_reset_token;
                 },
             ],
@@ -180,6 +183,7 @@ public function actions()
      *    ),
      *    @SWG\Response(response = 200, description = "Login Success")
      * )
+     *
      * @param LoginForm $form
      *
      * @return $this|array
@@ -254,14 +258,17 @@ public function actionLogin(LoginForm $form)
      *    ),
      *    @SWG\Response(response = 200, description = "success")
      * )
+     *
      * @param RegisterForm $form
      *
      * @return $this|array|User|\common\models\UserProfile
+     *
      * @throws \common\exceptions\SystemException
      */
     public function actionRegister(RegisterForm $form)
     {
         $form->load(app()->request->post());
+
         return $form->register();
     }
 
@@ -293,9 +300,6 @@ public function actionRegister(RegisterForm $form)
      *    ),
      *    @SWG\Response(response = 200, description = "success")
      * )
-     *
-     *
-     * @return null
      */
     public function actionResetPassword()
     {
@@ -326,7 +330,7 @@ public function actionResetPassword()
     }
 
     /**
-     * 用户鉴权接口
+     * 用户鉴权接口.
      *
      * @SWG\Post(
      *    path = "/auth/query",
@@ -345,7 +349,9 @@ public function actionResetPassword()
      *    ),
      *    @SWG\Response(response = 200, description = "success")
      * )
+     *
      * @return mixed
+     *
      * @throws UnauthorizedHttpException
      */
     public function actionQuery()
@@ -360,11 +366,12 @@ public function actionQuery()
 
         //更新在线状态
         $user->setOnline();
+
         return;
     }
 
     /**
-     * 验证手机号是否注册
+     * 验证手机号是否注册.
      *
      * @SWG\Post(
      *    path = "/auth/phone",