Log activity inside your Laravel app
The spatie/laravel-activity
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 litte 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->property('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 an activity being logged
$activity = Activity::all()->last();
$activity->description; //returns 'updated'
$activity->subject; //returns the instance of NewsItem that was created
Calling $activity->changes
will return this array:
[
'attributes' => [
'name' => 'original name',
'text' => 'Lorum',
],
'old' => [
'name' => 'updated name',
'text' => 'Lorum',
],
];
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Documentation
You'll find the documentation on https://docs.spatie.be/laravel-activitylog/v1.
Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the media library? Feel free to create an issue on GitHub, we'll try to address it as soon as possible.
If you've found a bug regarding security please mail freek@spatie.be instead of using the issue tracker.
Installation
You can install the package via composer:
composer require spatie/laravel-activitylog
Next, you must install the service provider:
// config/app.php
'providers' => [
...
Spatie\Activitylog\ActivitylogServiceProvider::class,
];
You can publish the migration with:
php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="migrations"
After the migration has been published 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="config"
This is the contents of the published config file:
return [
/**
* When running the clean-command all recording activites older than
* the number of days specified here will be deleted.
*/
'delete_records_older_than_days' => 365,
/**
* When not specifying a log name when logging activity
* we'll using this log name.
*/
'default_log_name' => 'default'
];
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
Credits
About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.