Activity logs

Author: heloufir

app/Core/HasLogsActivity.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Core;
+
+interface HasLogsActivity
+{
+
+    public function __toString(): string;
+
+    public function activityLogLink(): string;
+
+}

app/Core/LogsActivity.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace App\Core;
+
+use Illuminate\Support\HtmlString;
+use Spatie\Activitylog\LogOptions;
+use Spatie\Activitylog\Traits\LogsActivity as BaseLogsActivity;
+
+trait LogsActivity
+{
+
+    use BaseLogsActivity;
+
+    /**
+     * Activity log options definition
+     *
+     * @return LogOptions
+     */
+    public function getActivitylogOptions(): LogOptions
+    {
+        return LogOptions::defaults()
+            ->logOnly($this->getFillable())
+            ->setDescriptionForEvent(fn(string $eventName) => new HtmlString(
+                '<div class="flex flex-col gap-1">'
+                . auth()->user()->name . " " . $eventName . " " . $this->fromCamelCase((new \ReflectionClass($this))->getShortName()) . " " . $this
+                . ' <a class="text-primary-500 hover:underline hover:cursor-pointer" target="_blank" href="' . $this->activityLogLink() . '">' . __('See details') . '</a>'
+                . '</div>'
+            ));
+    }
+
+    /**
+     * Transform a camel case to normal case
+     *
+     * @param $input
+     * @return string
+     */
+    private function fromCamelCase($input)
+    {
+        $pattern = '!([A-Z][A-Z0-9]*(?=$|[A-Z][a-z0-9])|[A-Za-z][a-z0-9]+)!';
+        preg_match_all($pattern, $input, $matches);
+        $ret = $matches[0];
+        foreach ($ret as &$match) {
+            $match = $match == strtoupper($match) ?
+                strtolower($match) :
+                lcfirst($match);
+        }
+        return implode(' ', $ret);
+    }
+
+}

app/Http/Livewire/Administration/ActivityLogs.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Http\Livewire\Administration;
+
+use App\Models\TicketPriority;
+use Filament\Forms\Components\Grid;
+use Filament\Forms\Components\TextInput;
+use Filament\Forms\Concerns\InteractsWithForms;
+use Filament\Forms\Contracts\HasForms;
+use Livewire\Component;
+use Spatie\Activitylog\Models\Activity;
+
+class ActivityLogs extends Component implements HasForms
+{
+    use InteractsWithForms;
+
+    public $search;
+
+    public function mount(): void
+    {
+        $this->form->fill();
+    }
+
+    public function render()
+    {
+        $query = Activity::query();
+        if ($this->search) {
+            $query->where('description', 'like', '%' . $this->search . '%');
+        }
+        $logs = $query->paginate();
+        return view('livewire.administration.activity-logs', compact('logs'));
+    }
+
+    /**
+     * Form schema definition
+     *
+     * @return array
+     */
+    protected function getFormSchema(): array
+    {
+        return [
+            Grid::make(1)
+                ->schema([
+                    TextInput::make('search')
+                        ->label(__('Search for activity logs'))
+                        ->disableLabel()
+                        ->type('search')
+                        ->placeholder(__('Search for activity logs')),
+                ]),
+        ];
+    }
+
+    /**
+     * Search for activity logs
+     *
+     * @return void
+     */
+    public function search(): void
+    {
+        $data = $this->form->getState();
+        $this->search = $data['search'] ?? null;
+    }
+
+}

app/Http/Livewire/Administration/TicketPriorities.php

@@ -56,7 +56,7 @@ protected function getFormSchema(): array
     }
 
     /**
-     * Search for tickets statutses
+     * Search for tickets priorities
      *
      * @return void
      */

app/Http/Livewire/Administration/TicketStatuses.php

@@ -55,7 +55,7 @@ protected function getFormSchema(): array
     }
 
     /**
-     * Search for tickets statutses
+     * Search for tickets statuses
      *
      * @return void
      */

app/Http/Livewire/Administration/TicketTypes.php

@@ -56,7 +56,7 @@ protected function getFormSchema(): array
     }
 
     /**
-     * Search for tickets statutses
+     * Search for tickets types
      *
      * @return void
      */

app/Models/Comment.php

@@ -2,15 +2,17 @@
 
 namespace App\Models;
 
+use App\Core\HasLogsActivity;
+use App\Core\LogsActivity;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
-class Comment extends Model
+class Comment extends Model implements HasLogsActivity
 {
-    use HasFactory, SoftDeletes;
+    use HasFactory, SoftDeletes, LogsActivity;
 
     protected $fillable = [
         'owner_id',
@@ -35,4 +37,14 @@ public function ticket(): BelongsTo
     {
         return $this->belongsTo(Ticket::class);
     }
+
+    public function __toString(): string
+    {
+        return $this->content;
+    }
+
+    public function activityLogLink(): string
+    {
+        return route('tickets.number', $this->ticket->ticket_number);
+    }
 }

app/Models/Project.php

@@ -2,6 +2,8 @@
 
 namespace App\Models;
 
+use App\Core\HasLogsActivity;
+use App\Core\LogsActivity;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
@@ -10,9 +12,9 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
-class Project extends Model
+class Project extends Model implements HasLogsActivity
 {
-    use HasFactory, SoftDeletes;
+    use HasFactory, SoftDeletes, LogsActivity;
 
     protected $fillable = [
         'name',
@@ -34,11 +36,6 @@ public function owner(): BelongsTo
         return $this->belongsTo(User::class, 'owner_id');
     }
 
-    public function users(): BelongsToMany
-    {
-        return $this->belongsToMany(User::class, 'user_projects', 'project_id', 'user_id')->withPivot('role');
-    }
-
     public function tickets(): HasMany
     {
         return $this->hasMany(Ticket::class);
@@ -52,4 +49,14 @@ public function favoriteUsers(): BelongsToMany
         }
         return $query;
     }
+
+    public function __toString(): string
+    {
+        return $this->name;
+    }
+
+    public function activityLogLink(): string
+    {
+        return route('home');
+    }
 }

app/Models/Ticket.php

@@ -2,6 +2,8 @@
 
 namespace App\Models;
 
+use App\Core\HasLogsActivity;
+use App\Core\LogsActivity;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -10,9 +12,9 @@
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
-class Ticket extends Model
+class Ticket extends Model implements HasLogsActivity
 {
-    use HasFactory, SoftDeletes;
+    use HasFactory, SoftDeletes, LogsActivity;
 
     protected $fillable = [
         'title',
@@ -67,4 +69,14 @@ public function ticketNumber(): Attribute
             get: fn() => $this->project?->ticket_prefix . '' . $this->number
         );
     }
+
+    public function __toString(): string
+    {
+        return $this->title;
+    }
+
+    public function activityLogLink(): string
+    {
+        return route('tickets.number', $this->ticket_number);
+    }
 }

app/Models/TicketPriority.php

@@ -2,13 +2,15 @@
 
 namespace App\Models;
 
+use App\Core\HasLogsActivity;
+use App\Core\LogsActivity;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
-class TicketPriority extends Model
+class TicketPriority extends Model implements HasLogsActivity
 {
-    use HasFactory, SoftDeletes;
+    use HasFactory, SoftDeletes, LogsActivity;
 
     protected $fillable = [
         'title',
@@ -17,4 +19,14 @@ class TicketPriority extends Model
         'icon',
         'slug'
     ];
+
+    public function __toString(): string
+    {
+        return $this->title;
+    }
+
+    public function activityLogLink(): string
+    {
+        return route('administration.ticket-priorities');
+    }
 }