aaronschmied/laravel-model-history

This package is abandoned and no longer maintained. No replacement package was suggested.

An smtp server for recieving emails with laravel.

1.0.1 2019-10-17 23:26 UTC

Requires

• php: ^7.1
• illuminate/config: ^5.8|^6.0
• illuminate/database: ^5.8|^6.0
• illuminate/events: ^5.8|^6.0
• illuminate/log: ^5.8|^6.0
• illuminate/support: ^5.8|^6.0

Requires (Dev)

• orchestra/testbench: ^3.5|^4.2
• squizlabs/php_codesniffer: ^3.4

GPL-3.0

• Aaron Schmied

README

Records the changes made to an eloquent model.

Installation

composer require aaronschmied/laravel-model-history

The package is auto discovered.

To publish the migration file, run the following artisan command:

php artisan vendor:publish --provider="AaronSchmied\ModelHistory\Providers\ModelHistoryServiceProvider" --tag="migrations"

To change the config, publish it using the following command: (This step is optional)

php artisan vendor:publish --provider="AaronSchmied\ModelHistory\Providers\ModelHistoryServiceProvider" --tag="config"

Usage

Add the trait to your model class you want to record changes for:

use AaronSchmied\ModelHistory\Traits\RecordsChanges;
use Illuminate\Database\Eloquent\Model;

class Example extends Model {
    use RecordsChanges;
}

Your model now has a relation to all the changes made:

$example->changes->last();

AaronSchmied\ModelHistory\Change {
  #attributes: array:8 [
    ...
    "change_type" => "updated"
    "changes" => "{
        "before": {
            "body": "Some old content"
        },
        "after": {
            "body": "This is the new body"
        }
    }"
    "recorded_at" => "2019-06-21 23:31:15"
  ]
  ...
}

The change model also includes a relation to the user who made the change, as well as a timestamp when it was recorded.

You can filter the changes using the query scopes:

// Get the updates on the given model, by the given user, in the last 30 days:
Change::query()
    ->whereAuthor($user)
    ->whereSubject($model)
    ->whereType(Change::TYPE_UPDATED)
    ->whereRecordedBetween(now()->subDays(30), now())
    ->get();