dmfaux/laravel-activitylog

A very simple activity logger to monitor the users of your website or application

Log activity inside your Laravel app

, _(*1)

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., _(*2)

Here's a litte demo of how you can use it:, _(*3)

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

You can retrieve all activity using the Spatie\Activitylog\Models\Activity model., _(*4)

Activity::all();

Here's a more advanced example:, _(*5)

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->getExtraProperty('customProperty'); //returns 'customValue'
$lastLoggedActivity->description; //returns 'Look, I logged something'

Here's an example on event logging., _(*6)

$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:, _(*7)

[
   'attributes' => [
        'name' => 'updated name',
        'text' => 'Lorum',
    ],
    'old' => [
        'name' => 'original 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., _(*8)

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment you are required to send us a postcard from your hometown, mentioning which of our package(s) you are using., _(*9)

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium., _(*10)

The best postcards will get published on the open source page on our website., _(*11)

Documentation

You'll find the documentation on https://docs.spatie.be/laravel-activitylog/v1., _(*12)

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., _(*13)

If you've found a bug regarding security please mail freek@spatie.be instead of using the issue tracker., _(*14)

Installation

You can install the package via composer:, _(*15)

``` bash composer require spatie/laravel-activitylog, <sub>(*16)</sub>

Next, you must install the service provider:

```php
// config/app.php
'providers' => [
    ...
    Spatie\Activitylog\ActivitylogServiceProvider::class,
];

You can publish the migration with:, <sub>(*17)</sub>

php artisan vendor:publish --provider="Spatie\Activitylog\ActivitylogServiceProvider" --tag="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., <sub>(*18)</sub>

After the migration has been published you can create the activity_log table by running the migrations:, <sub>(*19)</sub>

php artisan migrate

You can optionally publish the config file with:, <sub>(*20)</sub>

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

This is the contents of the published config file:, <sub>(*21)</sub>

return [

    /**
     * When set to false, no activities will be saved to database.
     */
    'enabled' => env('ACTIVITY_LOGGER_ENABLED', true),

    /**
     * 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',


    /**
     * When set to true, the subject returns soft deleted models.
     */
     'subject_returns_soft_deleted_models' => false,


    /**
     * This model will be used to log activity. The only requirement is that
     * it should be or extend the Spatie\Activitylog\Models\Activity model.
     */
    'activity_model' => \Spatie\Activitylog\Models\Activity::class,     
];

Changelog

Please see CHANGELOG for more information what has changed recently., <sub>(*22)</sub>

Testing

bash $ composer test, <sub>(*23)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*24)</sub>

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker., <sub>(*25)</sub>

Credits

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

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., <sub>(*26)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*27)</sub>