Merge pull request #65 from humhub/enh/php-cs-fixer

Use PHP CS Fixer

.github/workflows/php-cs-fixer.yml

@@ -0,0 +1,7 @@
+name: PHP CS Fixer
+
+on: push
+
+jobs:
+  tests:
+    uses: humhub/actions/.github/workflows/module-php-cs-fixer.yml@main

Events.php

@@ -126,7 +126,7 @@ public static function onProfileSettingMenuInit($event)
             'label' => Yii::t('TwofaModule.base', 'Two-Factor Authentication'),
             'url' => Yii::$app->user->identity->createUrl(TwofaUrl::ROUTE_USER_SETTINGS),
             'isActive' => $isActiveMenu,
-            'sortOrder' => 300
+            'sortOrder' => 300,
         ]);
 
         if ($isActiveMenu) {

Module.php

@@ -61,7 +61,7 @@ public function isTwofaCheckUrl()
      * Get available drivers options for the 2fa module settings
      *
      * @param array|null Init options(Key - Driver class name, Value - Drive name), used to init None option and/or forced/default Driver
-     * @param boolean true - to load only enabled drivers, false - to load all implemented drivers for the module
+     * @param bool true - to load only enabled drivers, false - to load all implemented drivers for the module
      * @return array
      */
     public function getDriversOptions($driversOptions = [], $onlyEnabled = false)
@@ -123,7 +123,7 @@ public function getEnabledDrivers(bool $checkActive = true): array
     /**
      * Get length of verifying code
      *
-     * @return integer
+     * @return int
      */
     public function getCodeLength()
     {
@@ -133,7 +133,7 @@ public function getCodeLength()
     /**
      * Get length in days of remember me option
      *
-     * @return integer
+     * @return int
      */
     public function getRememberMeDays()
     {

assets/Assets.php

@@ -34,6 +34,6 @@ class Assets extends AssetBundle
      * @inheritDoc
      */
     public $publishOptions = [
-        'forceCopy' => false
+        'forceCopy' => false,
     ];
 }

controllers/CheckController.php

@@ -51,9 +51,8 @@ public function actionIndex()
 
         return $this->render('index', [
             'model' => $model, 'driver' => TwofaHelper::getDriver(),
-            'rememberDays' => Yii::$app->getModule('twofa')->getRememberMeDays()
+            'rememberDays' => Yii::$app->getModule('twofa')->getRememberMeDays(),
         ]);
     }
 
 }
-

controllers/ConfigController.php

@@ -1,50 +1,50 @@
-<?php
-
-/**
- * @link https://www.humhub.org/
- * @copyright Copyright (c) 2020 HumHub GmbH & Co. KG
- * @license https://www.humhub.com/licences
- *
- */
-
-namespace humhub\modules\twofa\controllers;
-
-use humhub\modules\admin\permissions\ManageModules;
-use humhub\modules\admin\components\Controller;
-use humhub\modules\twofa\helpers\TwofaHelper;
-use humhub\modules\twofa\models\Config;
-use Yii;
-
-class ConfigController extends Controller
-{
-    /**
-     * @inheritdoc
-     */
-    public function getAccessRules()
-    {
-        return [['permissions' => ManageModules::class]];
-    }
-
-    /**
-     * Configuration action for system admins.
-     */
-    public function actionIndex()
-    {
-        $model = new Config();
-
-        if ($model->load(Yii::$app->request->post()) && $model->save()) {
-            $this->view->saved();
-        }
-
-        $ip = Yii::$app->request->userIP;
-        if ($ip !== Yii::$app->request->remoteIP) {
-            $ip .= ', ' . Yii::$app->request->remoteIP;
-        }
-
-        return $this->render('module', [
-            'model' => $model,
-            'defaultDriverName' => TwofaHelper::getDriverByClassName($model->module->defaultDriver)->name,
-            'ip' => $ip,
-        ]);
-    }
-}
+<?php
+
+/**
+ * @link https://www.humhub.org/
+ * @copyright Copyright (c) 2020 HumHub GmbH & Co. KG
+ * @license https://www.humhub.com/licences
+ *
+ */
+
+namespace humhub\modules\twofa\controllers;
+
+use humhub\modules\admin\permissions\ManageModules;
+use humhub\modules\admin\components\Controller;
+use humhub\modules\twofa\helpers\TwofaHelper;
+use humhub\modules\twofa\models\Config;
+use Yii;
+
+class ConfigController extends Controller
+{
+    /**
+     * @inheritdoc
+     */
+    public function getAccessRules()
+    {
+        return [['permissions' => ManageModules::class]];
+    }
+
+    /**
+     * Configuration action for system admins.
+     */
+    public function actionIndex()
+    {
+        $model = new Config();
+
+        if ($model->load(Yii::$app->request->post()) && $model->save()) {
+            $this->view->saved();
+        }
+
+        $ip = Yii::$app->request->userIP;
+        if ($ip !== Yii::$app->request->remoteIP) {
+            $ip .= ', ' . Yii::$app->request->remoteIP;
+        }
+
+        return $this->render('module', [
+            'model' => $model,
+            'defaultDriverName' => TwofaHelper::getDriverByClassName($model->module->defaultDriver)->name,
+            'ip' => $ip,
+        ]);
+    }
+}

controllers/UserSettingsController.php

@@ -39,7 +39,7 @@ public function actionIndex()
         Assets::register($this->view);
 
         return $this->render('@twofa/views/config/user', [
-            'model' => $model
+            'model' => $model,
         ]);
     }
 

docs/CHANGELOG.md

@@ -4,6 +4,7 @@ Changelog
 1.1.4 (Unreleased)
 ----------------------
 - Enh #58: Tests for `next` version
+- Enh #65: Use PHP CS Fixer
 
 1.1.3 (June 8, 2023)
 --------------------

drivers/EmailDriver.php

@@ -45,7 +45,7 @@ public function send()
         /** @var BaseMessage $mail */
         $mail = Yii::$app->mailer->compose([
             'html' => '@twofa/views/mails/VerifyingCode',
-            'text' => '@twofa/views/mails/plaintext/VerifyingCode'
+            'text' => '@twofa/views/mails/plaintext/VerifyingCode',
         ], [
             'user' => $user,
             'code' => $this->getCode(),
@@ -61,6 +61,6 @@ protected function isValidUserEmail(): bool
         /* @var User $user */
         $user = Yii::$app->user->getIdentity();
 
-        return !empty($user->email) && (new EmailValidator)->validate($user->email);
+        return !empty($user->email) && (new EmailValidator())->validate($user->email);
     }
-}
+}

drivers/GoogleAuthenticatorDriver.php

@@ -20,8 +20,8 @@ class GoogleAuthenticatorDriver extends BaseDriver
     /**
      * @var string Setting name for secret code per User
      */
-    const SECRET_SETTING = 'twofaGoogleAuthSecret';
-    const SECRET_TEMP_SETTING = 'twofaGoogleAuthSecretTemp';
+    public const SECRET_SETTING = 'twofaGoogleAuthSecret';
+    public const SECRET_TEMP_SETTING = 'twofaGoogleAuthSecretTemp';
 
     /**
      * @inheritdoc
@@ -102,7 +102,7 @@ public function renderUserSettings($params)
                 'confirm.action.question' => Yii::t('TwofaModule.config', 'Do you really want to request a new code?') . '<br><br>'
                     . Yii::t('TwofaModule.config', 'Please <strong>do not forget</strong> to update the code in your authenticator app! If you do not do so, you will not be able to login.'),
                 'confirm.action.button' => Yii::t('TwofaModule.config', 'Request new code'),
-            ]
+            ],
         ]);
 
         $model = $this->getUserSettings();

helpers/TwofaHelper.php

@@ -21,9 +21,9 @@
 
 class TwofaHelper
 {
-    const USER_SETTING = 'twofaDriver';
-    const CODE_SETTING = 'twofaCode';
-    const CODE_CHARS = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
+    public const USER_SETTING = 'twofaDriver';
+    public const CODE_SETTING = 'twofaCode';
+    public const CODE_CHARS = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
 
     /**
      * Get settings manager of current User
@@ -131,7 +131,7 @@ public static function getDriver()
     /**
      * Check if at least one Group of the current User is enforced to 2fa
      *
-     * @return boolean
+     * @return bool
      */
     public static function isEnforcedUser()
     {

helpers/TwofaUrl.php

@@ -15,17 +15,17 @@ class TwofaUrl extends Url
     /**
      * @var string Route to display a form to check user by two-factor authentication
      */
-    const ROUTE_CHECK = '/twofa/check';
+    public const ROUTE_CHECK = '/twofa/check';
 
     /**
      * @var string Route to configure general module settings by admin
      */
-    const ROUTE_CONFIG = '/twofa/config';
+    public const ROUTE_CONFIG = '/twofa/config';
 
     /**
      * @var string Route to configure user settings by current User
      */
-    const ROUTE_USER_SETTINGS = '/twofa/user-settings';
+    public const ROUTE_USER_SETTINGS = '/twofa/user-settings';
 
     public static function toCheck()
     {
@@ -36,4 +36,4 @@ public static function toConfig()
     {
         return static::toRoute(static::ROUTE_CONFIG);
     }
-}
+}

models/CheckCode.php

@@ -35,7 +35,7 @@ public function rules()
             ['code', 'required'],
             ['code', 'string'],
             ['code', 'verifyCode'],
-            ['rememberBrowser', 'boolean']
+            ['rememberBrowser', 'boolean'],
         ];
     }
 

models/Config.php

@@ -73,7 +73,7 @@ public function rules()
             ['rememberMeDays', 'integer', 'max' => 365],
             ['enforcedGroups', 'in', 'range' => array_keys($this->module->getGroupsOptions()), 'allowArray' => true],
             ['enforcedMethod', 'in', 'range' => array_keys($this->module->getDriversOptions())],
-            ['trustedNetworks', 'string']
+            ['trustedNetworks', 'string'],
         ];
     }
 

models/GoogleAuthenticatorUserSettings.php

@@ -18,14 +18,13 @@
  */
 class GoogleAuthenticatorUserSettings extends Model
 {
-
     /**
      * @var string Pin code
      */
     public $pinCode;
 
     /**
-     * @var boolean Change secret code?
+     * @var bool Change secret code?
      */
     public $changeSecretCode;
 

models/UserSettings.php

@@ -20,7 +20,6 @@
  */
 class UserSettings extends Model
 {
-
     /**
      * @var Module
      */

tests/codeception/_pages/TwofaAuthPage.php

@@ -10,15 +10,14 @@
  */
 class TwofaAuthPage extends BasePage
 {
-
     public $route = 'twofa/check';
 
     /**
      * @param string $code
      */
     public function verify($code)
     {
-        if(method_exists($this->actor, 'waitForText')) {
+        if (method_exists($this->actor, 'waitForText')) {
             $this->actor->waitForText('Two-factor authentication');
         }
         $this->actor->fillField('CheckCode[code]', $code);

tests/codeception/_support/FunctionalTester.php

@@ -27,10 +27,10 @@
 class FunctionalTester extends \FunctionalTester
 {
     use _generated\FunctionalTesterActions;
-    
-   /**
-    * Define custom actions here
-    */
+
+    /**
+     * Define custom actions here
+     */
 
     /**
      * @return string

tests/codeception/_support/UnitTester.php

@@ -26,7 +26,7 @@ class UnitTester extends \UnitTester
 {
     use _generated\UnitTesterActions;
 
-   /**
-    * Define custom actions here
-    */
+    /**
+     * Define custom actions here
+     */
 }

tests/codeception/config/unit.php

@@ -1,3 +1,3 @@
 <?php
 
-return \tests\codeception\_support\HumHubTestConfiguration::getSuiteConfig('unit');
+return \tests\codeception\_support\HumHubTestConfiguration::getSuiteConfig('unit');

tests/codeception/functional/TwofaCest.php

@@ -13,7 +13,6 @@
 
 class TwofaCest
 {
-
     public function testCheckWrongVerifyingCode(FunctionalTester $I)
     {
         $I->wantTo('check wrong verifying code');
@@ -39,7 +38,7 @@ public function testVerifyCodeFromEmail(FunctionalTester $I)
         $I->see('Two-factor authentication');
 
         $adminMail = $I->grabLastSentEmail();
-        if(!array_key_exists('admin@example.com', $adminMail->getTo())) {
+        if (!array_key_exists('admin@example.com', $adminMail->getTo())) {
             $I->see('admin@example.com not in mails');
         }
 

tests/codeception/unit/TwofaTest.php

@@ -44,4 +44,4 @@ public function testDisableVerifying()
         $this->assertTrue(TwofaHelper::disableVerifying());
         $this->assertFalse(TwofaHelper::isVerifyingRequired());
     }
-}
+}

tests/config/test.php

@@ -10,5 +10,5 @@
     'fixtures' => [
         'default',
         //'twofa' => \tests\codeception\fixtures\TwofaFixture::class
-    ]
+    ],
 ];