scolib/laravel-action-log

A laravel package for logging user actions into the database

Laravel Action Log

![Latest Version on Packagist][ico-version] ![Build Status][ico-travis] ![Quality Score][ico-code-quality] , _(*1)

Install

Laravel 5.5.*

``` bash $ composer require scolib/laravel-action-log:1.3.*, <sub>(*2)</sub>

Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

### Laravel 5.4.*

``` bash
$ composer require scolib/laravel-action-log:1.2.*

Add the ServiceProvider to the providers array in config/app.php, <sub>(*3)</sub>

\Sco\ActionLog\LaravelServiceProvider::class,

If you want to use the facade to logging actions, add this to the aliases array in config/app.php, <sub>(*4)</sub>

'ActionLog' => Sco\ActionLog\Facade::class,

Publish config file

Copy the package config to your local config with the publish command:, <sub>(*5)</sub>

php artisan vendor:publish --provider="Sco\ActionLog\LaravelServiceProvider"

Default action log table name is action_logs, If you want to customize it, edit the config/actionlog.php, <sub>(*6)</sub>

Now run the artisan migrate command:, <sub>(*7)</sub>

php artisan migrate

Usage

Method 1

Override the property $events in your Model, <sub>(*8)</sub>

    protected $events = [
        'created'  => \Sco\ActionLog\Events\ModelWasCreated::class,
    ];

⚠ Note: Laravel 5.5
Renamed $events to $dispatchesEvents (#17961, b6472bf, 3dbe12f), <sub>(*9)</sub>

All available event, <sub>(*10)</sub>

[
    'created'   => \Sco\ActionLog\Events\ModelWasCreated::class,
    'deleted'   => \Sco\ActionLog\Events\ModelWasDeleted::class,
    'restored'  => \Sco\ActionLog\Events\ModelWasRestored::class,
    'saved'     => \Sco\ActionLog\Events\ModelWasSaved::class,
    'updated'   => \Sco\ActionLog\Events\ModelWasUpdated::class,
    'creating'  => \Sco\ActionLog\Events\ModelWillCreating::class,
    'deleting'  => \Sco\ActionLog\Events\ModelWillDeleting::class,
    'restoring' => \Sco\ActionLog\Events\ModelWillRestoring::class,
    'saving'    => \Sco\ActionLog\Events\ModelWillSaving::class,
    'updating'  => \Sco\ActionLog\Events\ModelWillUpdating::class,
]

Method 2

Manual logging actions, <sub>(*11)</sub>

// use event
event(new \Sco\ActionLog\Events\ManualEvent($type, $content));

// use factory
\Sco\ActionLog\Factory::info(LogInfo $info);

Change log

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

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*13)</sub>

Security

If you discover any security related issues, please email slice1213@gmail.com instead of using the issue tracker., <sub>(*14)</sub>

Credits

• klgd
• All Contributors

License

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