added missing comma that caused the testprocess to fail.

[bookstack] / app / Auth / Role.php

diff --git a/app/Auth/Role.php b/app/Auth/Role.php
index 917d8aa26192c0388fac58fa5970267f3e25969c..13ec6df16b8488c23120d9a129e617fcad99182b 100644 (file)
--- a/app/Auth/Role.php
+++ b/app/Auth/Role.php
@@ -3,7 +3,17 @@
 use BookStack\Auth\Permissions\JointPermission;
 use BookStack\Auth\Permissions\RolePermission;
 use BookStack\Model;
 use BookStack\Auth\Permissions\JointPermission;
 use BookStack\Auth\Permissions\RolePermission;
 use BookStack\Model;

+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Relations\HasMany;

 
 

+/**
+ * Class Role
+ * @property int $id
+ * @property string $display_name
+ * @property string $description
+ * @property string $external_auth_id
+ * @property string $system_name
+ */

 class Role extends Model
 {
 
 class Role extends Model
 {
 


@@ -19,9 +29,8 @@ class Role extends Model
 
     /**
      * Get all related JointPermissions.
 
     /**
      * Get all related JointPermissions.

-     * @return \Illuminate\Database\Eloquent\Relations\HasMany

      */
      */

-    public function jointPermissions()
+    public function jointPermissions(): HasMany

     {
         return $this->hasMany(JointPermission::class);
     }
     {
         return $this->hasMany(JointPermission::class);
     }


@@ -36,10 +45,8 @@ class Role extends Model
 
     /**
      * Check if this role has a permission.
 
     /**
      * Check if this role has a permission.

-     * @param $permissionName
-     * @return bool

      */
      */

-    public function hasPermission($permissionName)
+    public function hasPermission(string $permissionName): bool

     {
         $permissions = $this->getRelationValue('permissions');
         foreach ($permissions as $permission) {
     {
         $permissions = $this->getRelationValue('permissions');
         foreach ($permissions as $permission) {


@@ -52,7 +59,6 @@ class Role extends Model
 
     /**
      * Add a permission to this role.
 
     /**
      * Add a permission to this role.

-     * @param RolePermission $permission

      */
     public function attachPermission(RolePermission $permission)
     {
      */
     public function attachPermission(RolePermission $permission)
     {


@@ -61,39 +67,41 @@ class Role extends Model
 
     /**
      * Detach a single permission from this role.
 
     /**
      * Detach a single permission from this role.

-     * @param RolePermission $permission

      */
     public function detachPermission(RolePermission $permission)
     {
      */
     public function detachPermission(RolePermission $permission)
     {

-        $this->permissions()->detach($permission->id);
+        $this->permissions()->detach([$permission->id]);

     }
 
     /**
     }
 
     /**

-     * Get the role object for the specified role.
-     * @param $roleName
-     * @return Role
+     * Get the role of the specified display name.

      */
      */

-    public static function getRole($roleName)
+    public static function getRole(string $displayName): ?Role

     {
     {

-        return static::where('name', '=', $roleName)->first();
+        return static::query()->where('display_name', '=', $displayName)->first();

     }
 
     /**
      * Get the role object for the specified system role.
     }
 
     /**
      * Get the role object for the specified system role.

-     * @param $roleName
-     * @return Role

      */
      */

-    public static function getSystemRole($roleName)
+    public static function getSystemRole(string $systemName): ?Role

     {
     {

-        return static::where('system_name', '=', $roleName)->first();
+        return static::query()->where('system_name', '=', $systemName)->first();

     }
 
     /**
      * Get all visible roles
     }
 
     /**
      * Get all visible roles

-     * @return mixed

      */
      */

-    public static function visible()
+    public static function visible(): Collection

     {
     {

-        return static::where('hidden', '=', false)->orderBy('name')->get();
+        return static::query()->where('hidden', '=', false)->orderBy('name')->get();
+    }
+
+    /**
+     * Get the roles that can be restricted.
+     */
+    public static function restrictable(): Collection
+    {
+        return static::query()->where('system_name', '!=', 'admin')->get();

     }
 }
     }
 }