PHP8 Features

composer.json

@@ -9,7 +9,10 @@
             "email": "connor@sourcetoad.com"
         }
     ],
-    "minimum-stability": "dev",
+    "config": {
+        "sort-packages": true
+    },
+    "minimum-stability": "stable",
     "prefer-stable": true,
     "require": {
         "ext-json": "*",
@@ -34,7 +37,10 @@
         "laravel": {
             "providers": [
                 "Sourcetoad\\Logger\\LoggerServiceProvider"
-            ]
+            ],
+            "aliases": {
+                "Logger": "Sourcetoad\\Logger\\LoggerFacade"
+            }
         }
     },
     "require-dev": {

src/Commands/AuditModelResolver.php

@@ -9,21 +9,10 @@
 
 class AuditModelResolver extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
     protected $signature = 'logger:audit-resolver';
-
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Identifiers users associated with models/changes logged.';
 
-    public function handle()
+    public function handle(): void
     {
         AuditChange::query()->where('processed', false)->chunkById(200, function ($items) {
             /** @var AuditChange $item */

src/Helpers/AuditResolver.php

@@ -7,11 +7,7 @@
 
 class AuditResolver
 {
-    /**
-     * @param Model|null $model
-     * @return int|null
-     */
-    public static function findUserId($model): ?int
+    public static function findUserId(Model|null $model): ?int
     {
         if (empty($model)) {
             return null;

src/Listeners/LogExplicitLogout.php

@@ -8,10 +8,8 @@
 
 class LogExplicitLogout
 {
-    public function handle(Logout $event)
+    public function handle(Logout $event): void
     {
         resolve(Logger::class)->logExplicitLogout();
-
-        return true;
     }
 }

src/Listeners/LogFailedLogin.php

@@ -8,7 +8,7 @@
 
 class LogFailedLogin
 {
-    public function handle(Failed $event)
+    public function handle(Failed $event): void
     {
         resolve(Logger::class)->logFailedLogin();
     }

src/Listeners/LogLockedLogins.php

@@ -8,7 +8,7 @@
 
 class LogLockedLogins
 {
-    public function handle(Lockout $event)
+    public function handle(Lockout $event): void
     {
         resolve(Logger::class)->logLockedLogin();
     }

src/Listeners/LogPasswordReset.php

@@ -8,7 +8,7 @@
 
 class LogPasswordReset
 {
-    public function handle(PasswordReset $passwordReset)
+    public function handle(PasswordReset $passwordReset): void
     {
         resolve(Logger::class)->logPasswordReset();
     }

src/Listeners/LogSuccessfulLogin.php

@@ -8,7 +8,7 @@
 
 class LogSuccessfulLogin
 {
-    public function handle(Login $event)
+    public function handle(Login $event): void
     {
         resolve(Logger::class)->logSuccessfulLogin();
     }

src/Logger.php

@@ -16,12 +16,12 @@
 class Logger
 {
     /** @var Model[] */
-    private static $retrievedModels = [];
+    private static array $retrievedModels = [];
+    private static array $changedModels = [];
 
-    /** @var array */
-    private static $changedModels = [];
+    public static string $userModel = 'App/User';
 
-    public function logSuccessfulLogin()
+    public function logSuccessfulLogin(): AuditActivity
     {
         $type = ActivityType::SUCCESSFUL_LOGIN;
 
@@ -34,7 +34,7 @@ public function logSuccessfulLogin()
         return $this->logActivity($type, $keys);
     }
 
-    public function logExplicitLogout()
+    public function logExplicitLogout(): AuditActivity
     {
         $type = ActivityType::LOGOUT;
 
@@ -46,7 +46,7 @@ public function logExplicitLogout()
         return $this->logActivity($type, $keys);
     }
 
-    public function logFailedLogin()
+    public function logFailedLogin(): AuditActivity
     {
         $type = ActivityType::FAILED_LOGIN;
 
@@ -55,7 +55,7 @@ public function logFailedLogin()
         return $this->logActivity($type, $keys);
     }
 
-    public function logLockedLogin()
+    public function logLockedLogin(): AuditActivity
     {
         $type = ActivityType::LOCKED_OUT;
 
@@ -64,7 +64,7 @@ public function logLockedLogin()
         return $this->logActivity($type, $keys);
     }
 
-    public function logPasswordReset()
+    public function logPasswordReset(): AuditActivity
     {
         $type = ActivityType::PASSWORD_CHANGE;
 
@@ -88,7 +88,7 @@ public function logChangedModel(Model $model, array $fields): void
         ];
     }
 
-    public function logActivity(int $type, array $keys = [])
+    public function logActivity(int $type, array $keys = []): AuditActivity
     {
         $path = Request::path();
         $verb = $this->getHttpVerb(Request::method());
@@ -190,19 +190,13 @@ private function getNumericMorphMap(Model $model): int
 
     private function getHttpVerb(string $verb): int
     {
-        switch (strtolower($verb)) {
-            case 'get':
-                return HttpVerb::GET;
-            case 'post':
-                return HttpVerb::POST;
-            case 'patch':
-                return HttpVerb::PATCH;
-            case 'put':
-                return HttpVerb::PUT;
-            case 'delete':
-                return HttpVerb::DELETE;
-            default:
-                return HttpVerb::UNKNOWN;
-        }
+        return match (strtolower($verb)) {
+            'get' => HttpVerb::GET,
+            'post' => HttpVerb::POST,
+            'patch' => HttpVerb::PATCH,
+            'put' => HttpVerb::PUT,
+            'delete' => HttpVerb::DELETE,
+            default => HttpVerb::UNKNOWN,
+        };
     }
 }

src/LoggerFacade.php

@@ -7,7 +7,7 @@
 
 class LoggerFacade extends Facade
 {
-    protected static function getFacadeAccessor()
+    protected static function getFacadeAccessor(): string
     {
         return 'logger';
     }

src/LoggerServiceProvider.php

@@ -4,15 +4,16 @@
 namespace Sourcetoad\Logger;
 
 use Illuminate\Contracts\Http\Kernel;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\ServiceProvider;
 use Sourcetoad\Logger\Commands\AuditModelResolver;
 use Sourcetoad\Logger\Middleware\LogOutputtedKeys;
 
 class LoggerServiceProvider extends ServiceProvider
 {
-    public static $morphs = [];
+    public static array $morphs = [];
 
-    protected $listeners = [
+    protected array $listeners = [
         \Illuminate\Auth\Events\Login::class => [
             \Sourcetoad\Logger\Listeners\LogSuccessfulLogin::class,
         ],
@@ -30,7 +31,7 @@ class LoggerServiceProvider extends ServiceProvider
         ],
     ];
 
-    public function boot()
+    public function boot(): void
     {
         if ($this->app->runningInConsole()) {
             $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
@@ -44,7 +45,7 @@ public function boot()
         ], 'logger');
     }
 
-    public function register()
+    public function register(): void
     {
         $this->app->singleton(Logger::class, function () {
             return new Logger();
@@ -57,21 +58,21 @@ public function register()
         $this->registerMiddleware();
     }
 
-    private function registerMiddleware()
+    private function registerMiddleware(): void
     {
         app(Kernel::class)->pushMiddleware(LogOutputtedKeys::class);
     }
 
-    private function registerMorphMaps()
+    private function registerMorphMaps(): void
     {
         self::$morphs = config('logger.morphs', []);
     }
 
-    private function registerEventListeners()
+    private function registerEventListeners(): void
     {
         foreach ($this->listeners as $key => $listeners) {
             foreach ($listeners as $listener) {
-                \Event::listen($key, $listener);
+                Event::listen($key, $listener);
             }
         }
     }

src/Middleware/LogOutputtedKeys.php

@@ -9,28 +9,18 @@
 use Illuminate\Http\Response;
 use Illuminate\Http\RedirectResponse;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Log;
 use Sourcetoad\Logger\Enums\ActivityType;
 use Sourcetoad\Logger\Logger;
 
 class LogOutputtedKeys
 {
-    /**
-     * Handle an incoming request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
-     * @return mixed
-     */
-    public function handle($request, Closure $next)
+    public function handle(Request $request, Closure $next): mixed
     {
         return $next($request);
     }
 
-    /**
-     * @param Request $request
-     * @param $response
-     */
-    public function terminate(Request $request, $response)
+    public function terminate(Request $request, $response): void
     {
         $leadingStatusCodeNumber = substr((string) $response->getStatusCode(), 0, 1);
 
@@ -48,7 +38,7 @@ public function terminate(Request $request, $response)
             $data = [];
         } else {
             $data = [];
-            \Log::warning('Could not decode class to extract data keys: ' . get_class($response));
+            Log::warning('Could not decode class to extract data keys: ' . get_class($response));
         }
 
         if ($request->method() === 'GET') {