monooso/unobserve

Mute and unmute Laravel observers at will.

v3.0.0 2020-10-10 14:11 UTC

This package is auto-updated.

Last update: 2020-10-10 14:15:41 UTC


README

Build Status Quality Score Coverage Latest Stable Version License

About Unobserve

When testing Laravel applications, we frequently need to "silence" events, so as not to trigger additional side-effects. Laravel's Event::fake method is useful, but muting a specific model observer is still problematic.

Unobserve takes care of that, making it easy to mute and unmute an observer at will.

Requirements and installation

Select the appropriate branch for your version of Laravel.

Branch Laravel Versions PHP Version
1.x ^5.8, ^6.0 ^7.2
2.x ^7.0 ^7.2.5
3.x ^8.0 ^7.3.0

Install Unobserve using Composer:

composer require monooso/unobserve

Usage

First, add the CanMute trait to your observer class.

<?php

namespace App\Observers;

use Monooso\Unobserve\CanMute;

class UserObserver
{
    use CanMute;
}

You can now mute and unmute your observer as needed:

UserObserver::mute();
UserObserver::unmute();

License

Unobserve is open source software, released under the MIT license.