Customize Description

[deonthomasgy]

Hello Spatie Community,
I would like to customize the description of the logged change in a model.

for example I want to watch a column name 'input' and 'options' for changes and save a detailed description. By default this module sets the description to 'created, updated, deleted'. However I would like a description to be something like

The [causer->name] changed 'input' from 'old.value' to 'new.value'.
The [causer->name] deleted 'input value 'old.value'
....

How can I achieve this in a model?

[arifktk32]

I am looking exactly for this, any update on this?

[maiduyduc]

I use the way to create a Trait function and use this in Model

<?php

namespace App\Traits;

trait ActivityLogTrait
{
  public function getEventName($eventName)
  {
    if ($eventName == 'created') return " text you want to display ";
    if ($eventName == 'updated') return " text you want to display ";
    if ($eventName == 'deleted') return " text you want to display ";
  }
}

and use this in the Model

<?php

namespace App\Models\Post;

use App\Traits\ActivityLogTrait;
use Spatie\Activitylog\Traits\LogsActivity;

class Post extends Model
{
use LogsActivity, ActivityLogTrait;

public function getActivitylogOptions(): LogOptions
  {
    return LogOptions::defaults()
      ->logAll()
      ->logOnlyDirty()
      ->useLogName('project')
      ->logExcept(['updated_at'])
      ->dontSubmitEmptyLogs()
      ->setDescriptionForEvent(function (string $eventName) {
        return Auth::user()->name . $this->getEventName($eventName) . "the post";
      });
  }
}

[musuyaba]

Why do you actually need to do this? The activity logs table has properties that you can utilize as JSON.

However, if you truly need it, you can use a line similar to this one:

public function getActivitylogOptions(): LogOptions
    {
        return LogOptions::defaults()
            ->logFillable()
            ->useLogName('Post')
            ->setDescriptionForEvent(function (string $eventName) {
                if ($eventName === 'created') {
                    return 'Post created by user ' . Auth::user()->name . ' with Activity Logs id ' . Activity::all()->last()->id . ' and title ' . $this->title;
                } elseif ($eventName === 'updated') {
                    return 'Post updated by user ' . Auth::user()->name . ' with Activity Logs  id ' . Activity::all()->last()->id . ' and title ' . $this->title;
                } elseif ($eventName === 'deleted') {
                    return 'Post deleted by user ' . Auth::user()->name . ' with Activity Logs  id ' . Activity::all()->last()->id . ' and title ' . $this->title;
                }

                return 'Post event';
            });
    }

• When created:

{
    "id": 51,
    "log_name": "Post",
    "description": "Post created by user asdasd with Activity Logs id 50 and title Howtodoit",
    "subject_type": "App\\Models\\Post",
    "event": "created",
    "subject_id": 15,
    "causer_type": "App\\Models\\User",
    "causer_id": 1,
    "properties": {
        "attributes": {
            "title": "Howtodoit"
        }
    },
    "batch_uuid": null,
    "created_at": "2024-02-02T03:26:50.000000Z",
    "updated_at": "2024-02-02T03:26:50.000000Z"
}

• When updated:

{
    "id": 52,
    "log_name": "Post",
    "description": "Post updated by user asdasd with Activity Logs  id 51 and title Howtodoit?",
    "subject_type": "App\\Models\\Post",
    "event": "updated",
    "subject_id": 15,
    "causer_type": "App\\Models\\User",
    "causer_id": 1,
    "properties": {
        "attributes": {
            "title": "Howtodoit?"
        },
        "old": {
            "title": "Howtodoit"
        }
    },
    "batch_uuid": null,
    "created_at": "2024-02-02T03:27:42.000000Z",
    "updated_at": "2024-02-02T03:27:42.000000Z"
}

• When Deleted:

{
    "id": 53,
    "log_name": "Post",
    "description": "Post deleted by user asdasd with Activity Logs  id 54 and title Howtodoit?",
    "subject_type": "App\\Models\\Post",
    "event": "deleted",
    "subject_id": 13,
    "causer_type": "App\\Models\\User",
    "causer_id": 1,
    "properties": {
        "old": {
            "title": "Howtodoit?"
        }
    },
    "batch_uuid": null,
    "created_at": "2024-02-02T03:34:18.000000Z",
    "updated_at": "2024-02-02T03:34:18.000000Z"
}