Logging activity

On this page

  1. Description
  2. Setting a subject
  3. Setting a causer
  4. Setting custom properties

This is the most basic way to log activity:

activity()->log('Look mum, I logged something');

You can retrieve the activity using the Spatie\Activitylog\Models\Activity model.

$lastActivity = Activity::all()->last(); //returns the last logged activity

$lastActivity->description; //returns 'Look mum, I logged something';

You can specify on which object the activity is performed by using performedOn:

activity()
   ->performedOn($someContentModel)
   ->log('edited');

$lastActivity = Activity::all()->last(); //returns the last logged activity

$lastActivity->subject; //returns the model that was passed to `performedOn`;

The performedOn-function has a shorter alias name: on

You can set who or what caused the activity by using causedBy:

activity()
   ->causedBy($userModel)
   ->performedOn($someContentModel)
   ->log('edited');
   
$lastActivity = Activity::all()->last(); //returns the last logged activity

$lastActivity->causer; //returns the model that was passed to `causedBy`;

The causedBy()-function has a shorter alias named: by

If you're not using causedBy the package will automatically use the logged in user.

You can add any property you want to an activity by using withProperties

activity()
   ->causedBy($userModel)
   ->performedOn($someContentModel)
   ->withProperties(['key' => 'value'])
   ->log('edited');
   
$lastActivity = Activity::all()->last(); //returns the last logged activity
   
$lastActivity->getExtraProperty('key') //returns 'value';