Slightly modified to match PSR-12

Author: Jurager

src/Console/InstallCommand.php

@@ -23,6 +23,8 @@ class InstallCommand extends Command
 
     /**
      * Execute the console command.
+     *
+     * @return void
      */
     public function handle(): void
     {

src/Contracts/AddsTeamMembers.php

@@ -63,6 +63,12 @@ protected function authorization(Request $request, string $method, string|array
 
     /**
      * Check user's ability for the team.
+     *
+     * @param Request $request
+     * @param $team
+     * @param string $ability
+     * @param array|null $models
+     * @return bool
      */
     protected function checkTeamAbility(Request $request, $team, string $ability, ?array $models): bool
     {
@@ -86,8 +92,11 @@ protected function checkTeamAbility(Request $request, $team, string $ability, ?a
         return $request->user()->hasTeamAbility($team, $ability, $entity);
     }
 
+
     /**
      * The request is unauthorized, so it handles the aborting/redirecting.
+     *
+     * @return RedirectResponse
      */
     protected function unauthorized(): RedirectResponse
     {
@@ -112,6 +121,10 @@ protected function unauthorized(): RedirectResponse
 
     /**
      * Get the arguments parameters for the gate.
+     *
+     * @param Request $request
+     * @param array|null $models
+     * @return array
      */
     protected function getGateArguments(Request $request, ?array $models): array
     {

src/Contracts/DeletesTeams.php

@@ -9,7 +9,7 @@
  * @method static string model(string $model)
  * @method static object instance(string $model)
  *
- * @see \Jurager\Teams\Support\Services\TeamsService
+ * @see TeamsService
  */
 class Teams extends Facade
 {

src/Contracts/RemovesTeamMembers.php

@@ -2,7 +2,10 @@
 
 namespace Jurager\Teams\Support\Services;
 
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Config;
+use RuntimeException;
+use Exception;
 
 class TeamsService
 {
@@ -23,7 +26,7 @@ public function __construct()
      *
      * @param string $model
      * @return object
-     * @throws \Exception
+     * @throws Exception
      */
     public function instance(string $model): object
     {
@@ -35,7 +38,7 @@ public function instance(string $model): object
      *
      * @param string $model
      * @return string
-     * @throws \Exception
+     * @throws Exception
      */
     public function model(string $model): string
     {
@@ -48,16 +51,16 @@ public function model(string $model): string
      * @param string $key
      * @param bool $instance
      * @return string|object
-     * @throws \Exception
+     * @throws Exception
      *
-     * @template T of \Illuminate\Database\Eloquent\Model
+     * @template T of Model
      */
     private function getModel(string $key, bool $instance = false): string|object
     {
         $modelClass = $this->models[$key] ?? null;
 
         if (!$modelClass || !class_exists($modelClass)) {
-            throw new \RuntimeException("Model class for key $key not found.");
+            throw new RuntimeException("Model class for key $key not found.");
         }
 
         return $instance ? new $modelClass() : $modelClass;

src/Contracts/UpdatesTeamNames.php

@@ -15,6 +15,7 @@
 use Jurager\Teams\Events\TeamMemberUpdated;
 use Jurager\Teams\Models\Owner;
 use Jurager\Teams\Support\Facades\Teams;
+use RuntimeException;
 
 trait HasMembers
 {
@@ -113,17 +114,17 @@ public function hasUser(object $user): bool
     public function addUser(object $user, string $role_keyword): void
     {
         if ($user->id === $this->owner->id) {
-            throw new \RuntimeException(__('Owner already belongs to the team.'));
+            throw new RuntimeException(__('Owner already belongs to the team.'));
         }
 
         if ($this->hasUser($user)) {
-            throw new \RuntimeException(__('User already belongs to the team.'));
+            throw new RuntimeException(__('User already belongs to the team.'));
         }
 
         $role = $this->getRole($role_keyword);
 
         if (!$role) {
-            throw new \RuntimeException(__('Unable to find a role :role within team.', ['role' => $role_keyword]));
+            throw new RuntimeException(__('Unable to find a role :role within team.', ['role' => $role_keyword]));
         }
 
         // Dispatch an event before attaching the user
@@ -146,17 +147,17 @@ public function addUser(object $user, string $role_keyword): void
     public function updateUser(object $user, string $role_keyword): void
     {
         if ($user->id === $this->owner->id) {
-            throw new \RuntimeException(__('You may not change the team owner.'));
+            throw new RuntimeException(__('You may not change the team owner.'));
         }
 
         if (!$this->hasUser($user)) {
-            throw new \RuntimeException(__('User not belongs to the team.'));
+            throw new RuntimeException(__('User not belongs to the team.'));
         }
 
         $role = $this->getRole($role_keyword);
 
         if (!$role) {
-            throw new \RuntimeException(__('Unable to find a role :role within team.', ['role' => $role_keyword]));
+            throw new RuntimeException(__('Unable to find a role :role within team.', ['role' => $role_keyword]));
         }
 
         // Update the user role for the team
@@ -176,11 +177,11 @@ public function updateUser(object $user, string $role_keyword): void
     public function deleteUser(object $user): void
     {
         if ($user->id === $this->owner->id) {
-            throw new \RuntimeException(__('You may not remove the team owner.'));
+            throw new RuntimeException(__('You may not remove the team owner.'));
         }
 
         if (!$this->hasUser($user)) {
-            throw new \RuntimeException(__('User not belongs to the team.'));
+            throw new RuntimeException(__('User not belongs to the team.'));
         }
 
         // Detach the user from the team
@@ -228,7 +229,7 @@ public function userHasPermission(object $user, string|array $permissions, bool
     /**
      * Check if the team has a specific role by ID or code or any roles at all
      *
-     * @param string|null $keyword The role ID or code to check for. If null, checks for any roles.
+     * @param int|string|null $keyword The role ID or code to check for. If null, checks for any roles.
      * @return bool
      */
     public function hasRole(int|string|null $keyword = null): bool
@@ -263,7 +264,7 @@ public function getRole(int|string $keyword): object|null
     public function addRole(string $code, array $permissions, string|null $name = null, string|null $description = null): object
     {
         if ($this->hasRole($code)) {
-            throw new \RuntimeException("Role with code '$code' already exists.");
+            throw new RuntimeException("Role with code '$code' already exists.");
         }
 
         $role = $this->roles()->create([
@@ -325,7 +326,7 @@ public function deleteRole(int|string $keyword): bool
     /**
      * Check if the team has a specific group by ID or code or any groups at all
      *
-     * @param string|null $keyword The role ID or code to check for. If null, checks for any groups.
+     * @param int|string|null $keyword The role ID or code to check for. If null, checks for any groups.
      * @return bool
      */
     public function hasGroup(int|string|null $keyword = null): bool
@@ -359,7 +360,7 @@ public function getGroup(int|string $keyword): object|null
     public function addGroup(string $code, array $permissions = [], string|null $name = null): object
     {
         if ($this->hasGroup($code)) {
-            throw new \RuntimeException("Group with code '$code' already exists.");
+            throw new RuntimeException("Group with code '$code' already exists.");
         }
 
         $group = $this->groups()->create([

src/Middleware/Teams.php

@@ -168,6 +168,9 @@ public function teamPermissions(object $team, string|null $scope = null): array
     /**
      * Determine if the user has the given permission on the given team.
      *
+     * $require = true (all permissions in the array are required)
+     * $require = false (only one or more permission in the array are required or $permissions is empty)
+     *
      * @param object $team
      * @param string|array $permissions
      * @param bool $require
@@ -176,9 +179,6 @@ public function teamPermissions(object $team, string|null $scope = null): array
      */
     public function hasTeamPermission(object $team, string|array $permissions, bool $require = false, string|null $scope = null): bool
     {
-        //$require = true  (all permissions in the array are required)
-        //$require = false  (only one or more permission in the array are required or $permissions is empty)
-
         if ($this->ownsTeam($team)) {
             return true;
         }
@@ -238,7 +238,7 @@ public function teamAbilities(object $team, object $entity, bool $forbidden = fa
      *
      * This function is to verify permissions within a universal group.
      * Especially in cases where a team requires a group enabling user additions
-     * and removals without direct affiliation with the team
+     * and removals without direct affiliation with the team.
      *
      * Example: Each team should have a global group of moderators.
      *
@@ -438,6 +438,10 @@ private function getRelationName(object|string $classname): string
 
     /**
      * Check for wildcard permissions.
+     *
+     * @param array $userPermissions
+     * @param string $permission
+     * @return bool
      */
     private function checkPermissionWildcard(array $userPermissions, string $permission): bool
     {