Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yajra/laravel-auditable
Basic Auditable package for Eloquent Model.
https://github.com/yajra/laravel-auditable
audit-log eloquent hacktoberfest laravel php
Last synced: 6 days ago
JSON representation
Basic Auditable package for Eloquent Model.
- Host: GitHub
- URL: https://github.com/yajra/laravel-auditable
- Owner: yajra
- License: mit
- Created: 2016-01-28T07:14:34.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T06:09:01.000Z (8 months ago)
- Last Synced: 2024-10-17T19:24:49.827Z (21 days ago)
- Topics: audit-log, eloquent, hacktoberfest, laravel, php
- Language: PHP
- Homepage: http://yajrabox.com/docs/laravel-auditable
- Size: 88.9 KB
- Stars: 157
- Watchers: 3
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Auditable
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[](https://github.com/yajra/laravel-auditable/actions/workflows/continuous-integration.yml)
[](https://github.com/yajra/laravel-auditable/actions/workflows/static-analysis.yml)
[![Total Downloads][ico-downloads]][link-downloads]
Laravel Auditable is a simple Laravel auditing package for your Eloquent Model.
This package automatically inserts/updates an audit log on your table on who created and last updated the record.
## Laravel Version Compatibility
| Laravel | Package |
|:---------|:--------|
| 5.x-10.x | 4.x |
| 11.x | 11.x |
## Install via Composer
```bash
composer require yajra/laravel-auditable:^11
```
## Publish config file
If you want to modify the `withDefault` option on auditable columns, you may publish the config file.
```bash
php artisan vendor:publish --tag=auditable
```
## Usage
Update your model's migration and add `created_by` and `updated_by` field using the `auditable()` blueprint macro.
```php
Schema::create('users', function (Blueprint $table) {
$table->increments('id');
$table->string('name', 100);
$table->auditable();
$table->timestamps();
});
```
Then use `AuditableTrait` on your model.
``` php
namespace App;
use Yajra\Auditable\AuditableTrait;
class User extends Model
{
use AuditableTrait;
}
```
## Soft Deletes
If you wish to use Laravel's soft deletes, use the `auditableWithDeletes()` method on your migration instead:
```php
Schema::create('users', function (Blueprint $table) {
$table->increments('id');
$table->string('name', 100);
$table->auditableWithDeletes();
$table->timestamps();
$table->softDeletes()
});
```
Afterwards, you need to use `AuditableWithDeletesTrait` on your model.
``` php
namespace App;
use Yajra\Auditable\AuditableWithDeletesTrait;
class User extends Model
{
use AuditableWithDeletesTrait, SoftDeletes;
}
```
## Dropping columns
You can drop auditable columns using `dropAuditable()` method, or `dropAuditableWithDeletes()` if using soft deletes.
```php
Schema::create('users', function (Blueprint $table) {
$table->dropAuditable();
});
```
And you're done! The package will now automatically add a basic audit log for your model to track who inserted and last updated your records.
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Arjay Angeles][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/yajra/laravel-auditable.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/yajra/laravel-auditable/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/yajra/laravel-auditable.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/yajra/laravel-auditable.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/yajra/laravel-auditable.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/yajra/laravel-auditable
[link-travis]: https://travis-ci.org/yajra/laravel-auditable
[link-downloads]: https://packagist.org/packages/yajra/laravel-auditable
[link-author]: https://github.com/yajra
[link-contributors]: ../../contributors