How to use Laravel Model Observers?

Hello,

If you need to see example of laravel observers example. We will use how to use laravel model observers. you can understand a concept of what is observers in laravel. this example will help you laravel model observers.

i will explain you how to use laravel model observers event, you can easily use with laravel 6, laravel 7 and laravel 8 project.

Laravel Observers are used to group event listeners for a model eloquent. Laravel Observers will listener event for model eloquent method like create, update and delete.

I will give you very simple definition and use of laravel observers is, when you need to generate slug or auto generate unique id or something like logic add before or after create record then observers will help you. i will give you bellow events that provide by observers and simple example bellow:

Eloquent Hook

  • Retrieved: after a record has been retrieved.
  • Creating: before a record has been created.
  • Created: after a record has been created.
  • Updating: before a record is updated.
  • Updated: after a record has been updated.
  • Saving: before a record is saved (either created orupdated).
  • Saved: after a record has been saved (either created orupdated).
  • Deleting: before a record is deleted or soft-deleted.
  • Deleted: after a record has been deleted or soft-deleted.
  • Restoring: before a soft-deleted record is going to berestored.
  • Restored: after a soft-deleted record has been restored.

Example:

Now here we will see simple example, i have one product model and it has name, slug, price and unique_id column. so i need to create one record with name an price only. but when it’s create i need to generate slug from name and auto generate unique_id.

so let’s see how to create observers class and how it will works:

app/Models/Product.php

<?php

namespace AppModels;

use IlluminateDatabaseEloquentFactoriesHasFactory;

use IlluminateDatabaseEloquentModel;

class Product extends Model

{

use HasFactory;

protected $fillable = [

'name', 'price', 'slug', 'unique_id'

];

}

Create observers class for Product. So, create bellow command:

php artisan make:observer ProductObserver --model=Product

app/Observers/ProductObserver.php

<?php

namespace AppObservers;

use AppModelsProduct;

class ProductObserver

{

/**

* Handle the Product "created" event.

*

* @param AppModelsProduct $product

* @return void

*/

public function creating(Product $product)

{

$product->slug = Str::slug($product->name);

}

/**

* Handle the Product "created" event.

*

* @param AppModelsProduct $product

* @return void

*/

public function created(Product $product)

{

$product->unique_id = 'PR-'.$product->id;

$product->save();

}

/**

* Handle the Product "updated" event.

*

* @param AppModelsProduct $product

* @return void

*/

public function updated(Product $product)

{

}

/**

* Handle the Product "deleted" event.

*

* @param AppModelsProduct $product

* @return void

*/

public function deleted(Product $product)

{

}

/**

* Handle the Product "restored" event.

*

* @param AppModelsProduct $product

* @return void

*/

public function restored(Product $product)

{

}

/**

* Handle the Product "force deleted" event.

*

* @param AppModelsProduct $product

* @return void

*/

public function forceDeleted(Product $product)

{

}

}

Register Observers class on provider.

app/Providers/EventServiceProvider.php

<?php

namespace AppProviders;

use IlluminateAuthEventsRegistered;

use IlluminateAuthListenersSendEmailVerificationNotification;

use IlluminateFoundationSupportProvidersEventServiceProvider as ServiceProvider;

use IlluminateSupportFacadesEvent;

use AppObserversProductObserver;

use AppModelsProduct;

class EventServiceProvider extends ServiceProvider

{

/**

* The event listener mappings for the application.

*

* @var array

*/

protected $listen = [

Registered::class => [

SendEmailVerificationNotification::class,

],

];

/**

* Register any events for your application.

*

* @return void

*/

public function boot()

{

Product::observe(ProductObserver::class);

}

}

Create Demo Route:

routes/web.php

<?php

use IlluminateSupportFacadesRoute;

use AppHttpControllersProductController;

/*

|--------------------------------------------------------------------------

| Web Routes

|--------------------------------------------------------------------------

|

| Here is where you can register web routes for your application. These

| routes are loaded by the RouteServiceProvider within a group which

| contains the "web" middleware group. Now create something great!

|

*/

Route::get('product', [ProductController::class, 'index']);

Create Controller Route:

app/Http/Controllers/ProductController.php

<?php

namespace AppHttpControllers;

use AppModelsProduct;

use IlluminateHttpRequest;

class ProductController extends Controller

{

/**

* Display a listing of the resource.

*

* @return IlluminateHttpResponse

*/

public function index()

{

$product = Product::create([

'name' => 'Platinum 1',

'price' => 10

]);

dd($product);

}

}

now you can run project and see.

it will create record as like bellow:

How to use Laravel Model Observers?

I hope it can help you…

Leave a Comment