Download the PHP package joshbrw/laravel-audit-logging without Composer
On this page you can find all versions of the php package joshbrw/laravel-audit-logging. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download joshbrw/laravel-audit-logging
More information about joshbrw/laravel-audit-logging
Files in joshbrw/laravel-audit-logging
Package laravel-audit-logging
Short Description Fully translatable Audit Logging in Laravel.
License MIT
Informations about the package laravel-audit-logging
Laravel Audit Logging
A simple, easy-to-use audit logging system with translation at the heart. Uses UUIDs for easy dataset merging and management.
Installation
- Add
Joshbrw\AuditLogging\AuditLoggingServiceProviders,
under theproviders
key inconfig/app.php
. - Add
'Audit' => Joshbrw\AuditLogging\Facades\Audit::class,
under thealiases
key inconfig/app.php
to register the Facade - Run
php artisan vendor:publish --provider="Joshbrw\\AuditLogging\\AuditLoggingServiceProvider"
- this will publish the migration(s) to your top-leveldatabase/migrations
directory. - Run
php artisan migrate
to run the migration(s) provided with this package. - On each of your Eloquent models that you wish to log, add the
Joshbrw\AuditLogging\Traits\Eloquent\Auditable
trait.
Usage
Basic Attributes
Every Audit Log item has two required attributes:
auditable_type
|auditable_id
- The entity the audit relates tomessage_key
- The translation key of the message
The option attributes are:
message_replacements
- An array of replacements that should be passed to the translator when displaying the audit log.data
- Any array/object of data that you'd like to store against the Audit Log.user_id
- The ID of the User performing the action being logged. Supports Laravel's Auth and Sentinel by default, allows for custom adapters via the UserResolver
Using the Helper Methods & Service
This library ships with an audit()
method, with the following syntax:
Which simply proxies through to the Joshbrw\AuditLogging\AuditLogManager
service's log()
method, which accepts the same parameters.
Facade
The package also ships with a Facade which can be used as \Audit::
and proxies through to the AuditLogManager
, such as Audit::log()
and Audit::translate()
.
Fetching Audit Logs
You can use the AuditLogRepository
to fetch Audit Logs for a specific Eloquent Model:
- Ensure that the entity is using the
Auditable
trait. - See the following code to learn how to fetch all Audit Logs for the model, in reverse chronological order: