Merge pull request #435 from datamweb/style-fix

style: fix code style

Author: kenjis

src/Authorization/Traits/Authorizable.php

@@ -78,9 +78,9 @@ public function removeGroup(string ...$groups): self
      * so only those groups are valid for this user, removing
      * all groups not in this list.
      *
-     * @throws AuthorizationException
-     *
      * @return $this
+     *
+     * @throws AuthorizationException
      */
     public function syncGroups(string ...$groups): self
     {
@@ -124,9 +124,9 @@ public function getPermissions(): ?array
     /**
      * Adds one or more permissions to the current user.
      *
-     * @throws AuthorizationException
-     *
      * @return $this
+     *
+     * @throws AuthorizationException
      */
     public function addPermission(string ...$permissions): self
     {
@@ -187,9 +187,9 @@ public function removePermission(string ...$permissions): self
      * so only those permissions are valid for this user, removing
      * all permissions not in this list.
      *
-     * @throws AuthorizationException
-     *
      * @return $this
+     *
+     * @throws AuthorizationException
      */
     public function syncPermissions(string ...$permissions): self
     {
@@ -342,7 +342,6 @@ private function savePermissions(): void
 
     /**
      * @phpstan-param 'group'|'permission' $type
-     *
      * @param GroupModel|PermissionModel $model
      */
     private function saveGroupsOrPermissions(string $type, $model, array $cache): void

src/Config/Auth.php

@@ -122,7 +122,6 @@ class Auth extends BaseConfig
      * If no match is found, then the next in the chain will be checked.
      *
      * @var string[]
-     *
      * @phpstan-var list<string>
      */
     public array $authenticationChain = [
@@ -213,7 +212,7 @@ class Auth extends BaseConfig
         'CodeIgniter\Shield\Authentication\Passwords\CompositionValidator',
         'CodeIgniter\Shield\Authentication\Passwords\NothingPersonalValidator',
         'CodeIgniter\Shield\Authentication\Passwords\DictionaryValidator',
-        //'CodeIgniter\Shield\Authentication\Passwords\PwnedValidator',
+        // 'CodeIgniter\Shield\Authentication\Passwords\PwnedValidator',
     ];
 
     /**

src/Database/Migrations/2020-12-28-223112_create_auth_tables.php

@@ -132,7 +132,7 @@ public function up(): void
         $this->forge->createTable('auth_permissions_users');
     }
 
-    //--------------------------------------------------------------------
+    // --------------------------------------------------------------------
 
     public function down(): void
     {

src/Entities/Entity.php

@@ -16,7 +16,6 @@ abstract class Entity extends FrameworkEntity
      * Custom convert handlers
      *
      * @var array<string, string>
-     *
      * @phpstan-var array<string, class-string>
      */
     protected $castHandlers = [

src/Entities/User.php

@@ -35,9 +35,7 @@ class User extends Entity
 
     /**
      * @var string[]
-     *
      * @phpstan-var list<string>
-     *
      * @psalm-var list<string>
      */
     protected $dates = [

src/Entities/UserIdentity.php

@@ -35,9 +35,7 @@ class UserIdentity extends Entity
 
     /**
      * @var string[]
-     *
      * @phpstan-var list<string>
-     *
      * @psalm-var list<string>
      */
     protected $dates = [

src/Models/UserIdentityModel.php

@@ -76,7 +76,6 @@ public function createEmailIdentity(User $user, array $credentials): void
      * Create an identity with 6 digits code for auth action
      *
      * @phpstan-param array{type: string, name: string, extra: string} $data
-     *
      * @param callable $codeGenerator generate secret code
      *
      * @return string secret

src/Models/UserModel.php

@@ -99,7 +99,6 @@ protected function fetchIdentities(array $data): array
      * @param UserIdentity[] $identities
      *
      * @return User[] UserId => User object
-     *
      * @phpstan-return array<int|string, User> UserId => User object
      */
     private function assignIdentities(array $data, array $identities): array
@@ -220,9 +219,9 @@ public function activate(User $user): void
      *
      * @param array|User $data
      *
-     * @throws ValidationException
-     *
      * @return int|string|true Insert ID if $returnID is true
+     *
+     * @throws ValidationException
      */
     public function insert($data = null, bool $returnID = true)
     {

src/Result.php

@@ -26,7 +26,6 @@ class Result
 
     /**
      * @phpstan-param array{success: bool, reason?: string|null, extraInfo?: string|User} $details
-     *
      * @psalm-param array{success: bool, reason?: string|null, extraInfo?: string|User} $details
      */
     public function __construct(array $details)

tests/Language/AbstractTranslationTestCase.php

@@ -91,9 +91,9 @@ abstract class AbstractTranslationTestCase extends TestCase
      */
     protected array $excludedLocaleKeyTranslations = [];
 
-    //-------------------------------------------------------------------------
+    // -------------------------------------------------------------------------
     // TESTS
-    //-------------------------------------------------------------------------
+    // -------------------------------------------------------------------------
 
     /**
      * This tests that all language files configured in the main CI4 repository
@@ -328,9 +328,9 @@ final public function testLocaleHasCorrespondingTestCaseFile(string $locale): vo
         ));
     }
 
-    //-------------------------------------------------------------------------
+    // -------------------------------------------------------------------------
     // UTILITIES
-    //-------------------------------------------------------------------------
+    // -------------------------------------------------------------------------
 
     /**
      * Get all the ISO 639-1 and 639-2 locale codes.