File: README.md Copy Chapter

</a>

The spatie/laravel-activitylog package provides easy to use functions to log the activities of the users of your app. It can also automatically log model events.
The package stores all activity in the activity_log table.

Here's a demo of how you can use it:

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

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

Activity::all();

Here's a more advanced example:

activity()
   ->performedOn($anEloquentModel)
   ->causedBy($user)
   ->withProperties(['customProperty' => 'customValue'])
   ->log('Look, I logged something');

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

$lastLoggedActivity->subject; //returns an instance of an eloquent model
$lastLoggedActivity->causer; //returns an instance of your user model
$lastLoggedActivity->getProperty('customProperty'); //returns 'customValue'
$lastLoggedActivity->description; //returns 'Look, I logged something'

Here's an example on event logging.

$newsItem->name = 'updated name';
$newsItem->save();

//updating the newsItem will cause the logging of an activity
$activity = Activity::all()->last();

$activity->description; //returns 'updated'
$activity->subject; //returns the instance of NewsItem that was saved

Calling $activity->attribute_changes will return this collection:

[
   'attributes' => [
        'name' => 'updated name',
        'text' => 'Lorem',
    ],
    'old' => [
        'name' => 'original name',
        'text' => 'Lorem',
    ],
];

Support us Copy Chapter

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Documentation Copy Chapter

You'll find the documentation on https://spatie.be/docs/laravel-activitylog/introduction.

Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the activity log? Feel free to create an issue on GitHub, we'll try to address it as soon as possible.

Installation Copy Chapter

You can install the package via composer:

composer require spatie/laravel-activitylog

The package will automatically register itself.

You can publish the migration with:

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-migrations"

Note: The default migration assumes you are using integers for your model IDs. If you are using UUIDs, or some other format, adjust the format of the subject_id and causer_id fields in the published migration before continuing.

After publishing the migration you can create the activity_log table by running the migrations:

php artisan migrate

You can optionally publish the config file with:

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="activitylog-config"

Changelog Copy Chapter

Please see CHANGELOG for more information about recent changes.

Upgrading Copy Chapter

Please see UPGRADING for details.

Testing Copy Chapter

composer test

Contributing Copy Chapter

Please see CONTRIBUTING for details.

Security Copy Chapter

If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.

Credits Copy Chapter

• Freek Van der Herten
• Sebastian De Deyne
• Tom Witkowski
• All Contributors

Special thanks to Ahmed Nagi for all the work he put in v4 and to Caneco for the original logo.

License Copy Chapter

The MIT License (MIT). Please see License File for more information.

File: art/README.md Copy Chapter

Laravel Activity Log Art

The logo was inspired by the Spatie brand, and the well known minimal design of Laravel packages.

Fonts Copy Chapter

The logo is using the following fonts:

• Inter 500
• Inter 600

Colors Copy Chapter

Requirements Copy Chapter

• A screen or a printer

Installation Copy Chapter

• Open the file
• Right-click on the image
• Choose "Save image as…" option

Maintainers Copy Chapter

Laravel Activity Log logo is designed and maintained by Caneco.

License Copy Chapter

All rights reserved, but with the following extra conditions:

• It is OK to use the Laravel Activity Log logo in the following cases:

  • In marketing materials for technical events, e.g. meetups, hackathons, conferences and workshops that are related to Laravel.
  • In open source projects related to Laravel.
  • In technical articles/videos/books/papers for educational purposes.
  • To illustrate a commercial product.

• It is NOT OK to use the Laravel Activity Log logo in the following cases without prior written consent from the copyright owners:

  • Using the Laravel Activity Log logo in a commercial product for purposes other than illustrating its integration.
  • Sell physical products that uses the Laravel Activity Log logo or its variants, e.g. t-shirts.

By any means the owner reserves the right of final explanation for any use case not explicitly stated above.

File: docs/introduction.md Copy Chapter

title: Introduction weight: 1 Copy Chapter

The spatie/laravel-activitylog package provides easy to use functions to log the activities of the users of your app. It can also automatically log model events. All activity will be stored in the activity_log table.

Here's a little demo of how you can use it:

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

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

Activity::all();

Here's a more advanced example:

activity()
   ->performedOn($anEloquentModel)
   ->causedBy($user)
   ->withProperties(['customProperty' => 'customValue'])
   ->log('Look mum, I logged something');

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

$lastLoggedActivity->subject; //returns an instance of an eloquent model
$lastLoggedActivity->causer; //returns an instance of your user model
$lastLoggedActivity->getProperty('customProperty'); //returns 'customValue'
$lastLoggedActivity->description; //returns 'Look mum, I logged something'

Here's an example on event logging.

$newsItem->name = 'updated name';
$newsItem->save();

//updating the newsItem will cause an activity to be logged
$activity = Activity::all()->last();

$activity->description; //returns 'updated'
$activity->subject; //returns the instance of NewsItem that was updated

Calling $activity->attribute_changes will return this collection:

[
    'attributes' => [
        'name' => 'updated name',
        'text' => 'Lorem',
    ],
    'old' => [
        'name' => 'original name',
        'text' => 'Lorem',
    ],
];

We have badges! Copy Chapter