Logging activity | laravel-activitylog | Spatie

 SPATIE

  Laravel Activity Log
=======================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-activitylog](https://spatie.be/docs/laravel-activitylog/v3)  Basic-usage  Logging activity

 Version   v5   v4   v3   v2   v1

 Other versions for crawler [v5](https://spatie.be/docs/laravel-activitylog/v5) [v4](https://spatie.be/docs/laravel-activitylog/v4) [v3](https://spatie.be/docs/laravel-activitylog/v3) [v2](https://spatie.be/docs/laravel-activitylog/v2) [v1](https://spatie.be/docs/laravel-activitylog/v1)

- [ Introduction ](https://spatie.be/docs/laravel-activitylog/v3/introduction)
- [ Support us ](https://spatie.be/docs/laravel-activitylog/v3/support-us)
- [ Requirements ](https://spatie.be/docs/laravel-activitylog/v3/requirements)
- [ Installation and Setup ](https://spatie.be/docs/laravel-activitylog/v3/installation-and-setup)
- [ Questions and issues ](https://spatie.be/docs/laravel-activitylog/v3/questions-and-issues)
- [ Changelog ](https://spatie.be/docs/laravel-activitylog/v3/changelog)
- [ Upgrading ](https://spatie.be/docs/laravel-activitylog/v3/upgrading)
- [ About us ](https://spatie.be/docs/laravel-activitylog/v3/about-us)

Basic usage
-----------

- [ Logging activity ](https://spatie.be/docs/laravel-activitylog/v3/basic-usage/logging-activity)
- [ Cleaning up the log ](https://spatie.be/docs/laravel-activitylog/v3/basic-usage/cleaning-up-the-log)

Advanced usage
--------------

- [ Logging model events ](https://spatie.be/docs/laravel-activitylog/v3/advanced-usage/logging-model-events)
- [ Using placeholders ](https://spatie.be/docs/laravel-activitylog/v3/advanced-usage/using-placeholders)
- [ Using multiple logs ](https://spatie.be/docs/laravel-activitylog/v3/advanced-usage/using-multiple-logs)
- [ Disabling logging ](https://spatie.be/docs/laravel-activitylog/v3/advanced-usage/disabling-logging)

      You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command:

 `                                    composer show spatie/laravel-activitylog                                                                                                                                                                                                                                    `

Logging activity
================

###  On this page

1. [ Description ](#content-description)
2. [ Setting a subject ](#content-setting-a-subject)
3. [ Setting a causer ](#content-setting-a-causer)
4. [ Setting custom properties ](#content-setting-custom-properties)
5. [ Setting custom created date ](#content-setting-custom-created-date)
6. [ Tap Activity before logged ](#content-tap-activity-before-logged)

Description
-----------------------------------------------------------------------------------------

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';
```

Setting a subject
-----------------------------------------------------------------------------------------------------------

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`

Setting a causer
--------------------------------------------------------------------------------------------------------

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.

If you don't want to associate a model as causer of activity, you can use `causedByAnonymous` (or the shorter alias: `byAnonymous`).

Setting custom properties
-----------------------------------------------------------------------------------------------------------------------------------

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'

$lastActivity->where('properties->key', 'value')->get(); // get all activity where the `key` custom property is 'value'
```

Setting custom created date
-----------------------------------------------------------------------------------------------------------------------------------------

You can set a custom activity created\_at date time by using `createdAt`

```
activity()
    ->causedBy($userModel)
    ->performedOn($someContentModel)
    ->createdAt(now()->subDays(10))
    ->log('created')
```

Tap Activity before logged
--------------------------------------------------------------------------------------------------------------------------------------

You can use the `tap()` method to fill properties and add custom fields before the activity is saved.

```
use Spatie\Activitylog\Contracts\Activity;

activity()
   ->causedBy($userModel)
   ->performedOn($someContentModel)
   ->tap(function(Activity $activity) {
      $activity->my_custom_field = 'my special value';
   })
   ->log('edited');

$lastActivity = Activity::all()->last();

$lastActivity->my_custom_field; // returns 'my special value'
```