Download the PHP package davidiwezulu/audittrail without Composer
On this page you can find all versions of the php package davidiwezulu/audittrail. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download davidiwezulu/audittrail
More information about davidiwezulu/audittrail
Files in davidiwezulu/audittrail
Package audittrail
Short Description Laravel package that automatically tracks changes to Eloquent models
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package audittrail
Davidiwezulu/AuditTrail
Overview
Davidiwezulu/AuditTrail is a Laravel package that automatically tracks changes to Eloquent models, providing:
- Versioning: Each modification to a model is stored as a new version.
- Rollback Capabilities: Easily revert any model to a previous version.
- Detailed Logs: Record what was changed, when, and by whom (with user tracking).
This package is designed for applications that require comprehensive audit trails, ensuring data integrity and easy recovery of historical data.
Features
- Automatically tracks
created,updated, anddeletedevents for any Eloquent model. - Maintains a log of both the old and new values of changed attributes.
- Supports rollback to any previous version of a model.
- Logs changes made by authenticated users.
- Detailed audit history accessible via relationships.
Installation
Requirements
- Laravel 9.x or newer
- PHP 8.0 or newer
Step 1: Install via Composer
Run the following command to install the package:
Step 2: Publish and Run Migrations
Publish the migration file for the audit_trails table:
Run the migrations:
Configuration
This package comes with default settings, but you can publish the configuration file if you'd like to customize the package further:
Usage
Step 1: Use the Auditable Trait in Your Model
To enable audit tracking for a model, use the Auditable trait in your Eloquent model:
Once the trait is included, the package will automatically log created, updated, and deleted events for this model.
Step 2: Accessing Audit Trails
You can retrieve the audit trail for a specific model using the auditTrails() relationship:
Step 3: Rollback to a Previous Version
To rollback a model to a previous version, you can use the rollbackTo() method:
The model will be restored to the old values recorded in the selected audit trail.
Events
By default, the package listens to the created, updated, and deleted events. You can modify which events are tracked by overriding the getAuditEvents method in your model:
Testing
This package comes with unit tests to ensure functionality. To run the tests, use the following command within the package itself:
Test Scenarios
1. Model Changes:
Verify that created, updated, and deleted events generate appropriate audit logs.
2. Rollback:
Ensure models can be reverted to previous versions using the rollback feature.
3. Relationships:
Confirm that the audit trail's morph relationships are correctly established between auditable models and users.
Contribution Guidelines
If you wish to contribute to this package, please follow these steps:
- Fork the repository.
-
Create a feature branch:
-
Commit your changes:
-
Push to the branch:
- Open a pull request, and provide a description of your changes.
All contributions must adhere to the following guidelines:
- Ensure code quality by following the Laravel style guide.
- Add unit tests for any new features or bug fixes.
- Update the README with any changes that impact usage.
License
This package is open-source software licensed under the MIT License.
