Download the PHP package aliirfaan/laravel-simple-audit-log without Composer
On this page you can find all versions of the php package aliirfaan/laravel-simple-audit-log. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aliirfaan/laravel-simple-audit-log
More information about aliirfaan/laravel-simple-audit-log
Files in aliirfaan/laravel-simple-audit-log
Package laravel-simple-audit-log
Short Description This package creates a database table to save audit logs and exposes events to log user actions.
License MIT
Informations about the package laravel-simple-audit-log
Laravel Simple Audit Log
Many systems need to log user actions for auditing purposes. This package creates a database table with sensible fields for logging actions.
Features
- Table structure to keep audit logs
- Event driven
- Configurable connection if using a different database for recording logs
- Configurable model
- Audit log service
- log request ip, app environment
Table fields
This is only a dump to explain fields. Table will be created via Laravel migration file.
Events
You can dispatch these events to record logs. You can also listen to these events if you want additional processing.
- AuditLogged
Requirements
- Composer
- Laravel
- MySQL 4.x + VARBINARY data type is available as from 4.x
Installation
You can install this package on an existing Laravel project with using composer:
Register the ServiceProvider by editing config/app.php file and adding to providers array:
Note: use the following for Laravel <5.1 versions:
Publish files with:
or by using only php artisan vendor:publish
and select the aliirfaan\LaravelSimpleAuditLog\SimpleAuditLogProvider
from the outputted list.
Apply the migrations:
Configuration
This package publishes an simple-audit-log.php
file inside your applications's config
folder which contains the settings for this package. Most of the variables are bound to environment variables, but you are free to directly edit this file, or add the configuration keys to the .env
file.
audit_log_db_connection | String
The database connection to use. Defaults to environment variable 'DB_CONNECTION'.
audit_log_model | String The model you want to use. The model must implement aliirfaan\LaravelSimpleAuditLog\Contracts\SimpleAuditLog
should_prune | Boolean Whether to prune records
prune_days | Numeric to delete records older than prune_days
Usage
Custom model
If you have have additional requirements for our audit logs, you can add columns using migation and use a custom model to use your new columns.
Add your custom model to the configuration file.
Specify custom model to configuration file
License
The MIT License (MIT)
Copyright (c) 2020
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.