Merge pull request #26 from me-shaon/schedule-data-purning

Scheduled task for pruning old data

Author: me-shaon

README.md

@@ -52,8 +52,57 @@ return [
     'ignore-paths' => [
 
     ],
+    
+    'pruning' => [
+        'enabled' => env('REQUEST_ANALYTICS_PRUNING_ENABLED', true),
+        'days' => env('REQUEST_ANALYTICS_PRUNING_DAYS', 90),
+    ],
 ];
 ```
+### Data Purning 
+You can delete your data from your database automatically.
+
+If you are using Laravel 11+ then you may use `model:prune` command.
+Add this to your `routes/console.php`
+
+```php
+use Illuminate\Support\Facades\Schedule;
+ 
+Schedule::command('model:prune', [
+            '--model' => 'MeShaon\RequestAnalytics\Models\RequestAnalytics',
+        ])->daily();
+``` 
+Or try this `bootstarp/app.php`
+```php
+use Illuminate\Console\Scheduling\Schedule;
+->withSchedule(function (Schedule $schedule) {
+     $schedule->command('model:prune', [
+            '--model' => 'MeShaon\RequestAnalytics\Models\RequestAnalytics',
+        ])->daily();
+    })
+```
+
+If you are using Laravel 10 or below then you may use `model:prune` command.
+You may define all of your scheduled tasks in the schedule method of your application's `App\Console\Kernel` class
+```php
+<?php
+
+namespace App\Console;
+
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+
+class Kernel extends ConsoleKernel
+{
+    protected function schedule(Schedule $schedule): void
+    {
+        $schedule->command('model:prune', [
+            '--model' => 'MeShaon\RequestAnalytics\Models\RequestAnalytics',
+        ])->daily();
+    }
+}
+```
+
 You can publish the assets with this command:
 ```bash
 php artisan vendor:publish --tag="request-analytics-assets"

config/request-analytics.php

@@ -18,4 +18,9 @@
     'ignore-paths' => [
 
     ],
+
+    'pruning' => [
+        'enabled' => env('REQUEST_ANALYTICS_PRUNING_ENABLED', true),
+        'days' => env('REQUEST_ANALYTICS_PRUNING_DAYS', 90),
+    ],
 ];

src/Models/RequestAnalytics.php

@@ -2,16 +2,33 @@
 
 namespace MeShaon\RequestAnalytics\Models;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\MassPrunable;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Carbon;
 
 class RequestAnalytics extends Model
 {
-    use HasFactory;
+    use HasFactory, MassPrunable;
 
     public const UPDATED_AT = null;
 
     public const CREATED_AT = null;
 
     protected $guarded = ['id', 'created_at', 'updated_at'];
+
+    /**
+     * Get the prunable model query.
+     */
+    public function prunable(): Builder
+    {
+        if (! config('request-analytics.pruning.enabled', false)) {
+            return $this->whereRaw('1 = 0');
+        }
+
+        $days = config('request-analytics.pruning.days', 90);
+
+        return static::where('visited_at', '<=', Carbon::now()->subDays($days));
+    }
 }