codewiser / journalism

1.2.5 2020-05-11 07:15 UTC

Requires

• ext-json: *
• laravel/framework: >=5.8

MIT

• Michael Pogrebnikov

• Audit
• laravel
• journal
• illuminate

Published on Packagist.org on 2020-05-11 07:14 UTC

README

Record any (model or custom) events to store and review history

Service Provider

Add the package to your application service providers in config/app.php file.

'providers' => [
    
    /*
     * Laravel Framework Service Providers...
     */
    Illuminate\Foundation\Providers\ArtisanServiceProvider::class,
    Illuminate\Auth\AuthServiceProvider::class,
    ...
    
    /**
     * Third Party Service Providers...
     */
    Codewiser\Journalism\JournalServiceProvider::class,

],

Migrations

Publish the package migrations to your application. Run these commands inside your terminal.

php artisan vendor:publish --provider="Codewiser\Journalism\JournalServiceProvider"

And also run migrations.

php artisan migrate

Using as Trait

Add Journal to you Model.

class Post extends Model {
    use Codewiser\Journalism\Traits\Journalised;
}

For now every Eloquent event will be journalized.

And you can journal any events you want.

$post = Post::first();

// Record an event
$post->journalise('my-event');

You may add to the journal record any payload you want.

$post->journalise('my-event', /* jsonable data */);

Or using as Observer

class AppServiceProvider extends ServiceProvider 
{
    public function boot()
    {
        Post::observe(Codewiser\Journalism\Observers\Journalist::class);
    }
}

Auth Subscriber

Package provides mechanism to records auth events.

class EventServiceProvider extends ServiceProvider
{
    protected $subscribe = [
        Codewiser\Journalism\Subscribers\Concierge::class,
    ];
}

Subscriber detects auth/register, auth/login, auth/logout, auth/reset-password and auth/fail events.

Custom journal records

Lets imagine, every time user wants to update the Post, he must explain, why changes were made.

class Controller
{
    public function update(Request $request, $id)
    {
        $post = Post::find($id);
        $post->journalise('comment', $request->get('comment'));
        $post->update($request->all());
    }
}

Accessing history

You have access to full history with user explanations:

foreach ($post->journal as $record) {
    echo "At {$record->created_at} 
          user {$record->user['name']} 
          makes {$record->event}\n";
    
    echo "Payload was: " . json_encode($record->payload);
}