Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tpenaranda/model-log
A Laravel 5 package to log attributes changes of any of your app models.
https://github.com/tpenaranda/model-log
attributes changes composer eloquent laravel laravel-5-package laravel5 logger logging model tate track
Last synced: 2 months ago
JSON representation
A Laravel 5 package to log attributes changes of any of your app models.
- Host: GitHub
- URL: https://github.com/tpenaranda/model-log
- Owner: tpenaranda
- License: gpl-3.0
- Created: 2018-01-03T15:21:54.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T04:13:32.000Z (over 4 years ago)
- Last Synced: 2024-09-30T12:42:45.551Z (3 months ago)
- Topics: attributes, changes, composer, eloquent, laravel, laravel-5-package, laravel5, logger, logging, model, tate, track
- Language: PHP
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel ModelLog
[](https://packagist.org/packages/tpenaranda/model-log) [](https://packagist.org/packages/tpenaranda/model-log) [](https://packagist.org/packages/tpenaranda/model-log)
A Laravel package to automatically log attributes changes on any of your app models.
## About package
This package is intended for tracking changes of your Eloquent models inside your Laravel application.
A new DB table will be created and everytime a model attribute is updated an entry will be automatically created on the DB log table.
## Installation
Install package using [Composer](http://getcomposer.org).
$ composer require tpenaranda/model-log
Run migrations to create ModelLog table.
$ php artisan migrate
## [This step is not needed on Laravel >= 5.5] Add service provider and create ModelLog DB table.
Add service provider and alias in config/app.php
```
'providers' => [
...
TPenaranda\ModelLog\Providers\ModelLogServiceProvider::class,
],
'aliases' => [
...
'ModelLogEntry' => TPenaranda\ModelLog\ModelLogEntry::class,
'ObservedByModelLog' => TPenaranda\ModelLog\Traits\ObservedByModelLog::class,
],
```
Run ModelLog command in order to create ModelLog DB table.
$ php artisan model-log:create-log-table
## Usage
Add 'ObservedByModelLog' trait to your model and specify attributes you want to observe/track for changes.
```
use TPenaranda\ModelLog\Traits\ObservedByModelLog;
class MyModel extends Model
{
use ObservedByModelLog;
protected $log = ['my_attribute', 'track_this_column_too'];
}
```
Now after every update on that model, observed attributes will be logged automatically.
Use `protected $log = 'all';` (notice the string, not array) to log any change.
Retrieve log entries:
```
$my_model->logEntries;
```
## Advanced usage
Retrieve log entries using query scopes:
```
\ModelLogEntry::whereModelClass('App\MyModel')->whereAttribute('my_attribute')->whereTo('value_after_change')->get();
```
Available scopes:
- whereModel(``): _Get logs of an specific Eloquent Model_ (example: get log data of MyModel ID #4).
- whereModelClass(``): _Get logs for an specific model class_ (example: get entries where MyModel class is involved, regardless of any IDs).
- whereAttribute(``): _Get only logs where some specific attribute was changed._
- whereFrom(``): _Get only logs with an specific initial value._
- whereTo(``): _Get only logs with an specific end value._
- ModifiedByUser(``): _Get changes done by some specific user._ Allowed parameters: null, numeric IDs or User object.
The following scopes only accept [Carbon](http://carbon.nesbot.com) objects as parameters:
- loggedBefore(``): _Retrieve only entries logged prior to specific date._
- loggedAfter(``): _Retrieve only entries logged after specific date._
- withinDateRange(``, ``): _Retrieve only entries logged after first parameter and prior to second parameter._
Create (or drop and create) ModelLog table manually:
$ php artisan model-log:create-log-table
Flush ModelLog table:
```
\ModelLogEntry::flushAll();
```