Add unit test for ip addess searching

[bookstack] / app / Auth / Role.php

diff --git a/app/Auth/Role.php b/app/Auth/Role.php
index 629cd6a955d8abf7961b67aa1c598d1d62d30658..71da88e19b1be5200cb4f41dd6396427efd7c65b 100644 (file)
--- a/app/Auth/Role.php
+++ b/app/Auth/Role.php
@@ -1,23 +1,30 @@
-<?php namespace BookStack\Auth;
+<?php
+
+namespace BookStack\Auth;

 
 use BookStack\Auth\Permissions\JointPermission;
 use BookStack\Auth\Permissions\RolePermission;
 use BookStack\Interfaces\Loggable;
 use BookStack\Model;
 use Illuminate\Database\Eloquent\Collection;
 
 use BookStack\Auth\Permissions\JointPermission;
 use BookStack\Auth\Permissions\RolePermission;
 use BookStack\Interfaces\Loggable;
 use BookStack\Model;
 use Illuminate\Database\Eloquent\Collection;

+use Illuminate\Database\Eloquent\Factories\HasFactory;

 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 
 /**
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 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.
+ *
+ * @property int        $id
+ * @property string     $display_name
+ * @property string     $description
+ * @property string     $external_auth_id
+ * @property string     $system_name
+ * @property bool       $mfa_enforced
+ * @property Collection $users

  */
 class Role extends Model implements Loggable
 {
  */
 class Role extends Model implements Loggable
 {

+    use HasFactory;

 
     protected $fillable = ['display_name', 'description', 'external_auth_id'];
 
 
     protected $fillable = ['display_name', 'description', 'external_auth_id'];
 


@@ -56,6 +63,7 @@ class Role extends Model implements Loggable
                 return true;
             }
         }
                 return true;
             }
         }

+

         return false;
     }
 
         return false;
     }
 


@@ -78,7 +86,7 @@ class Role extends Model implements Loggable
     /**
      * Get the role of the specified display name.
      */
     /**
      * Get the role of the specified display name.
      */

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

     {
         return static::query()->where('display_name', '=', $displayName)->first();
     }
     {
         return static::query()->where('display_name', '=', $displayName)->first();
     }


@@ -86,13 +94,13 @@ class Role extends Model implements Loggable
     /**
      * Get the role object for the specified system role.
      */
     /**
      * Get the role object for the specified system role.
      */

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

     {
         return static::query()->where('system_name', '=', $systemName)->first();
     }
 
     /**
     {
         return static::query()->where('system_name', '=', $systemName)->first();
     }
 
     /**

-     * Get all visible roles
+     * Get all visible roles.

      */
     public static function visible(): Collection
     {
      */
     public static function visible(): Collection
     {


@@ -104,11 +112,14 @@ class Role extends Model implements Loggable
      */
     public static function restrictable(): Collection
     {
      */
     public static function restrictable(): Collection
     {

-        return static::query()->where('system_name', '!=', 'admin')->get();
+        return static::query()
+            ->where('system_name', '!=', 'admin')
+            ->orderBy('display_name', 'asc')
+            ->get();

     }
 
     /**
     }
 
     /**

-     * @inheritdoc
+     * {@inheritdoc}

      */
     public function logDescriptor(): string
     {
      */
     public function logDescriptor(): string
     {