Merge pull request #2852 from nAa6666/add-translations

Add translations support for exception messages

Author: drbyte

src/Exceptions/GuardDoesNotMatch.php

@@ -9,6 +9,9 @@ class GuardDoesNotMatch extends InvalidArgumentException
 {
     public static function create(string $givenGuard, Collection $expectedGuards)
     {
-        return new static("The given role or permission should use guard `{$expectedGuards->implode(', ')}` instead of `{$givenGuard}`.");
+        return new static(__('The given role or permission should use guard `:expected` instead of `:given`.', [
+            'expected' => $expectedGuards->implode(', '),
+            'given' => $givenGuard,
+        ]));
     }
 }

src/Exceptions/PermissionAlreadyExists.php

@@ -8,6 +8,9 @@ class PermissionAlreadyExists extends InvalidArgumentException
 {
     public static function create(string $permissionName, string $guardName)
     {
-        return new static("A `{$permissionName}` permission already exists for guard `{$guardName}`.");
+        return new static(__('A `:permission` permission already exists for guard `:guard`.', [
+            'permission' => $permissionName,
+            'guard' => $guardName,
+        ]));
     }
 }

src/Exceptions/PermissionDoesNotExist.php

@@ -8,7 +8,10 @@ class PermissionDoesNotExist extends InvalidArgumentException
 {
     public static function create(string $permissionName, ?string $guardName)
     {
-        return new static("There is no permission named `{$permissionName}` for guard `{$guardName}`.");
+        return new static(__('There is no permission named `:permission` for guard `:guard`.', [
+            'permission' => $permissionName,
+            'guard' => $guardName,
+        ]));
     }
 
     /**
@@ -17,6 +20,9 @@ public static function create(string $permissionName, ?string $guardName)
      */
     public static function withId($permissionId, ?string $guardName)
     {
-        return new static("There is no [permission] with ID `{$permissionId}` for guard `{$guardName}`.");
+        return new static(__('There is no [permission] with ID `:id` for guard `:guard`.', [
+            'id' => $permissionId,
+            'guard' => $guardName,
+        ]));
     }
 }

src/Exceptions/RoleAlreadyExists.php

@@ -8,6 +8,9 @@ class RoleAlreadyExists extends InvalidArgumentException
 {
     public static function create(string $roleName, string $guardName)
     {
-        return new static("A role `{$roleName}` already exists for guard `{$guardName}`.");
+        return new static(__('A role `:role` already exists for guard `:guard`.', [
+            'role' => $roleName,
+            'guard' => $guardName,
+        ]));
     }
 }

src/Exceptions/RoleDoesNotExist.php

@@ -8,7 +8,10 @@ class RoleDoesNotExist extends InvalidArgumentException
 {
     public static function named(string $roleName, ?string $guardName)
     {
-        return new static("There is no role named `{$roleName}` for guard `{$guardName}`.");
+        return new static(__('There is no role named `:role` for guard `:guard`.', [
+            'role' => $roleName,
+            'guard' => $guardName,
+        ]));
     }
 
     /**
@@ -17,6 +20,9 @@ public static function named(string $roleName, ?string $guardName)
      */
     public static function withId($roleId, ?string $guardName)
     {
-        return new static("There is no role with ID `{$roleId}` for guard `{$guardName}`.");
+        return new static(__('There is no role with ID `:id` for guard `:guard`.', [
+            'id' => $roleId,
+            'guard' => $guardName,
+        ]));
     }
 }

src/Exceptions/UnauthorizedException.php

@@ -13,10 +13,10 @@ class UnauthorizedException extends HttpException
 
     public static function forRoles(array $roles): self
     {
-        $message = 'User does not have the right roles.';
+        $message = __('User does not have the right roles.');
 
         if (config('permission.display_role_in_exception')) {
-            $message .= ' Necessary roles are '.implode(', ', $roles);
+            $message .= ' ' . __('Necessary roles are :roles', ['roles' => implode(', ', $roles)]);
         }
 
         $exception = new static(403, $message, null, []);
@@ -27,10 +27,10 @@ public static function forRoles(array $roles): self
 
     public static function forPermissions(array $permissions): self
     {
-        $message = 'User does not have the right permissions.';
+        $message = __('User does not have the right permissions.');
 
         if (config('permission.display_permission_in_exception')) {
-            $message .= ' Necessary permissions are '.implode(', ', $permissions);
+            $message .= ' ' . __('Necessary permissions are :permissions', ['permissions' => implode(', ', $permissions)]);
         }
 
         $exception = new static(403, $message, null, []);
@@ -41,10 +41,10 @@ public static function forPermissions(array $permissions): self
 
     public static function forRolesOrPermissions(array $rolesOrPermissions): self
     {
-        $message = 'User does not have any of the necessary access rights.';
+        $message = __('User does not have any of the necessary access rights.');
 
         if (config('permission.display_permission_in_exception') && config('permission.display_role_in_exception')) {
-            $message .= ' Necessary roles or permissions are '.implode(', ', $rolesOrPermissions);
+            $message .= ' ' . __('Necessary roles or permissions are :values', ['values' => implode(', ', $rolesOrPermissions)]);
         }
 
         $exception = new static(403, $message, null, []);
@@ -57,12 +57,14 @@ public static function missingTraitHasRoles(Authorizable $user): self
     {
         $class = get_class($user);
 
-        return new static(403, "Authorizable class `{$class}` must use Spatie\Permission\Traits\HasRoles trait.", null, []);
+        return new static(403, __('Authorizable class `:class` must use Spatie\\Permission\\Traits\\HasRoles trait.', [
+            'class' => $class,
+        ]), null, []);
     }
 
     public static function notLoggedIn(): self
     {
-        return new static(403, 'User is not logged in.', null, []);
+        return new static(403, __('User is not logged in.'), null, []);
     }
 
     public function getRequiredRoles(): array

src/Exceptions/WildcardPermissionInvalidArgument.php

@@ -8,6 +8,6 @@ class WildcardPermissionInvalidArgument extends InvalidArgumentException
 {
     public static function create()
     {
-        return new static('Wildcard permission must be string, permission id or permission instance');
+        return new static(__('Wildcard permission must be string, permission id or permission instance'));
     }
 }

src/Exceptions/WildcardPermissionNotImplementsContract.php

@@ -8,6 +8,6 @@ class WildcardPermissionNotImplementsContract extends InvalidArgumentException
 {
     public static function create()
     {
-        return new static('Wildcard permission class must implements Spatie\Permission\Contracts\Wildcard contract');
+        return new static(__('Wildcard permission class must implement Spatie\\Permission\\Contracts\\Wildcard contract'));
     }
 }

src/Exceptions/WildcardPermissionNotProperlyFormatted.php

@@ -8,6 +8,8 @@ class WildcardPermissionNotProperlyFormatted extends InvalidArgumentException
 {
     public static function create(string $permission)
     {
-        return new static("Wildcard permission `{$permission}` is not properly formatted.");
+        return new static(__('Wildcard permission `:permission` is not properly formatted.', [
+            'permission' => $permission,
+        ]));
     }
 }