https://github.com/elaborate-code/laravel-eloquent-logs
[Abandoned] Log changes that occur on Eloquent models
https://github.com/elaborate-code/laravel-eloquent-logs
eloquent events laravel logging package
Last synced: 5 months ago
JSON representation
[Abandoned] Log changes that occur on Eloquent models
- Host: GitHub
- URL: https://github.com/elaborate-code/laravel-eloquent-logs
- Owner: elaborate-code
- License: mit
- Archived: true
- Created: 2022-07-23T20:23:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-09T19:41:10.000Z (over 2 years ago)
- Last Synced: 2025-10-10T09:16:29.345Z (9 months ago)
- Topics: eloquent, events, laravel, logging, package
- Language: PHP
- Homepage: https://packagist.org/packages/elaborate-code/laravel-eloquent-logs
- Size: 95.7 KB
- Stars: 19
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-eloquent-logs
[](https://packagist.org/packages/elaborate-code/laravel-eloquent-logs)
[](https://packagist.org/packages/elaborate-code/laravel-eloquent-logs)
[](https://github.com/elaborate-code/laravel-eloquent-logs/actions/workflows/run-tests.yml)
[](https://github.com/elaborate-code/laravel-eloquent-logs/actions/workflows/fix-php-code-style-issues.yml)
Log what happens to your Eloquent models (`created`|`updated`|`deleted`|`soft deleted`|`restored`|`force deleted`) and keep and eye on **who** made the change, **how** and **when**.
This solution is simple to integrate and introduces minimal changes to your project: 1 migration, 1 model, 1 trait, and 1 facade.
## Installation
Install the package via composer:
```bash
composer require elaborate-code/laravel-eloquent-logs
```
Publish the migrations:
```bash
php artisan vendor:publish --tag="eloquent-logs-migrations"
```
Run the migrations:
```bash
php artisan migrate
```
### Publishing config file [Optional]
You can publish the config file with:
```bash
php artisan vendor:publish --tag="eloquent-logs-config"
```
This is the contents of the published config file:
```php
return [
'logs_model' => \ElaborateCode\EloquentLogs\Models\EloquentLog::class,
'logs_table' => 'eloquent_logs',
'user' => \App\Models\User::class,
];
```
That allows you to rename the `logs_table` before running the migrations.
## Usage
Pick an **Eloquent model** that you want to log the changes that happen to it and add the `HasLogs` trait to it.
```php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
class ExampleModel extends Model
{
use \ElaborateCode\EloquentLogs\Concerns\HasLogs;
// ...
}
```
After adding that trait, every change made to the model will be recorded.
Important warning from [Laravel docs](https://laravel.com/docs/9.x/eloquent#events:~:text=When%20issuing%20a%20mass%20update%20or,when%20performing%20mass%20updates%20or%20deletes.)
> When issuing a **mass update or delete** query via Eloquent, the `saved`, `updated`, `deleting`, and `deleted` model events will not be dispatched for the affected models. This is because the models are never actually retrieved when performing mass updates or deletes.
### Retrieving logs
You can load a model's logs using the `eloquentLogs` relationship:
```php
$example_model->eloquentLogs;
$example_model->load('eloquentLogs');
App\Models\ExampleModel::with('eloquentLogs')->find($id);
```
And you can query logs directly:
```php
// latest 5 logs with affected models
ElaborateCode\EloquentLogs\Models\EloquentLog::with('loggable')->latest()->limit(5)->get()
```
### Grouping queries
By default each one model event will result in a query to log the action.
```php
$example_model = ExampleModel::create(['name' => 'foo']);
$example_model->update(['name' => 'bar']);
$example_model->delete();
// ⚠️ This will result in 3 queries to insert the 3 events logs into the database
```
You can improve the logging process by using the `CacheEloquentLogQueries` facade
```php
use ElaborateCode\EloquentLogs\Facades\CacheEloquentLogQueries;
CacheEloquentLogQueries::start();
$example_model = ExampleModel::create(['name' => 'foo']);
$example_model->update(['name' => 'bar']);
$example_model->delete();
CacheEloquentLogQueries::execute();
// 👍 This will result in 1 query to insert the 3 events logs into the database
```
The facade includes other methods that you wouldn't necessarily need to use:
```php
// Stops caching and empties the cache without queries execution
CacheEloquentLogQueries::reset();
// Empties the cache but doesn't stop caching
CacheEloquentLogQueries::flushQueries();
// Stops caching until the reuse of start() and doesn't empty the cache
CacheEloquentLogQueries::suspend();
// Returns a boolean
CacheEloquentLogQueries::isCaching();
```
### Ignoring events
You can specify the events to not log on the model instances by listing the events to ignore on `YourModel::$loggableOptions['ignore']`.
```php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
class ExampleModel extends Model
{
use \ElaborateCode\EloquentLogs\Concerns\HasLogs;
public static array $loggableOptions = [
'ignore' => ['created', 'updated', 'deleted', 'softDeleted', 'forceDeleted', 'restored'],
];
// ...
}
```
### Muting Eloquent events [Laravel stuff]
From seeders:
```php
namespace Database\Seeders;
use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;
class DatabaseSeeder extends Seeder
{
use WithoutModelEvents; // Add this trait
public function run(): void
{
// Silent eloquent queries ...
}
}
```
Anywhere from your code:
```php
\Illuminate\Database\Eloquent\Model::unsetEventDispatcher();
// Silent eloquent queries ...
\Illuminate\Database\Eloquent\Model::setEventDispatcher(app(Dispatcher::class));
// ...
```
Explore the [Eloquent docs](https://laravel.com/docs/9.x/eloquent#muting-events) for more options
## Alternative
Among the bajillion packages that Spatie has so graciously bestowed upon the community, you'll find the excellent [laravel-Alternative](https://github.com/spatie/laravel-activitylog) package.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/elaborate-code/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [medilies](https://github.com/elaborate-code)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.