Eloquent ORM společnosti Laravel je výkonný nástroj pro interakci s databázemi. Jednou z jeho význačných funkcí je modelové události, které umožňují reagovat na konkrétní akce prováděné na modelech. V tomto příspěvku na blogu se seznámíme s tím, co jsou události modelů Eloquent, jak je používat a s praktickými případy použití - to vše jednoduchým jazykem, který je vhodný pro začátečníky.

Co jsou události modelu Eloquent v Laravelu?

Události modelu Eloquent umožňují spustit kód, když se s modely provedou určité akce. Můžete například spustit specifickou logiku, když:

• Záznam je vytvořen nebo aktualizován.
• Záznam je odstraněn nebo obnoven.
• Záznam je načten z databáze.

Tyto události pomáhají automatizovat úlohy, jako je protokolování, ověřování dat, odesílání oznámení a další. Představte si je jako háčky, které můžete použít k propojení dalších funkcí s životním cyklem záznamů v databázi.

Dostupné události Eloquent Model

Laravel poskytuje události pro různé fáze životního cyklu modelu:

• vyhledáno na adrese: Spouští se při načtení záznamu z databáze.
• vytvoření: Spouští se před vložením nového záznamu do databáze.
• vytvořeno: Spouští se po vložení nového záznamu.
• aktualizace: Spouští se před aktualizací existujícího záznamu.
• aktualizováno: Spouští se po aktualizaci existujícího záznamu.
• ukládání: Spouští se před uložením záznamu (platí pro vytváření i aktualizaci).
• uloženo: Spouští se po uložení záznamu (platí pro vytváření i aktualizaci).
• mazání: Spouští se před smazáním záznamu.
• smazáno: Spouští se po smazání záznamu.
• obnovení: Spouští se před obnovením soft-deleted záznamu.
• restaurováno: Spouští se po obnovení soft-deleted záznamu.

Tyto události vám dávají plnou kontrolu nad chováním modelu v každé fázi jeho životního cyklu.

Jak používat události modelu Eloquent

Existují tři hlavní způsoby zpracování událostí modelu Eloquent: pomocí příkazu $dispatchesEvents vlastnosti, uzávěry a pozorovatele.

1. Použití $dispatchesEvents Majetek

Laravel umožňuje mapovat události modelu na vlastní třídy událostí pomocí příkazu $dispatchesEvents ve vašem modelu. Tento přístup je výhodný, pokud chcete zapouzdřit logiku obsluhy událostí do samostatných tříd, což přispívá k čistšímu a lépe udržovatelnému kódu. Je důležité si uvědomit, že pro zde mapované události byste měli definovat posluchači událostí pro zpracování odesílaných událostí.

Zde je návod, jak ji definovat:

use App\Events\UserCreated;
use Illuminate\Database\Eloquent\Model;
 
class User extends Model
{
    protected $dispatchesEvents = [
        'created' => UserCreated::class,
    ];
}

V tomto příkladu:

• Když se objeví nový User je vytvořen model UserCreated je událost odeslána automaticky. Měli byste také vytvořit posluchače události pro UserCreated zpracovávat logiku spojenou s touto událostí.

2. Používání uzávěrů

Pro přímočarou obsluhu událostí můžete definovat uzávěry přímo v modelu. booted metoda. Tato metoda je ideální pro jednoduchou logiku, která nevyžaduje samostatnou třídu událostí.

Příklad:

use Illuminate\Database\Eloquent\Model;
 
class User extends Model
{
    protected static function booted()
    {
        static::created(function ($user) {
            // Logic to execute after a user is created
        });
    }
}

V tomto nastavení:

• Uzavření v rámci static::created se provede ihned po vytvoření nového uživatele.

3. Použití pozorovatelů

Pozorovatelé umožňují seskupit veškerou logiku zpracování událostí do jediné třídy, což zlepšuje organizaci, zejména pokud se jedná o více událostí nebo modelů.

• Definice pozorovatele

Pozorovatele můžete vytvořit pomocí příkazu Artisan:

php artisan make:observer UserObserver --model=User

Tento příkaz generuje UserObserver třída:

namespace App\Observers;
 
use App\Models\User;
 
class UserObserver
{
    public function creating(User $user)
    {
        $user->username = strtolower($user->username);
    }
 
    public function updating(User $user)
    {
        if ($user->isDirty('email')) {
            // Handle email changes
        }
    }
}

• Registrace pozorovatelů

Existují dva základní způsoby registrace pozorovatelů:

a. Na adrese AppServiceProvider:

V rámci boot metoda vašeho AppServiceProvider, můžete pozorovatele zaregistrovat:

use App\Models\User;
use App\Observers\UserObserver;
 
public function boot()
{
    User::observe(UserObserver::class);
}

b. Jako atribut PHP:

Případně můžete pomocí atributů PHP registrovat pozorovatele přímo v modelu:

use App\Observers\UserObserver;
use Illuminate\Database\Eloquent\Attributes\ObservedBy;
 
#[ObservedBy(UserObserver::class)]
class User extends Model
{
    // Model logic
}

Tato metoda nabízí stručný způsob přiřazování pozorovatelů k modelům.

Praktické případy použití modelových událostí

Zde je několik scénářů, ve kterých modelové události Eloquent vynikají:

1. Zaznamenávání změn

   • Sledování změn důležitých polí, jako jsou uživatelské role nebo stavy účtů.

2. Odesílání oznámení

   • Upozorňovat uživatele na aktualizaci jejich profilu nebo změnu stavu objednávky.

3. Zachování integrity dat

   • Automatické odstranění souvisejících záznamů při odstranění nadřazeného záznamu.

4. Prosazování obchodních pravidel

   • Zabránit určitým akcím, jako je odstraňování účtů správce.

Osvědčené postupy pro používání modelových událostí

1. Zachovejte jednoduchou logiku: Vyhněte se vkládání složité logiky do posluchačů událostí. Místo toho delegujte úlohy na třídy služeb nebo úlohy.
2. Důkladné testování: Zajistěte, aby posluchači událostí fungovali správně a nezpůsobovali chyby.
3. Dbejte na výkon: Dlouho běžící úlohy v posluchačích událostí mohou zpomalit aplikaci. Pro takové úlohy použijte systém fronty Laravel.

Závěr

Události modelu Eloquent představují výkonný způsob, jak se připojit k životnímu cyklu modelů a provádět vlastní logiku. Ať už zaznamenáváte změny, posíláte oznámení nebo vynucujete pravidla, události modelu dělají vaši aplikaci chytřejší a efektivnější. Pomocí $dispatchesEvents, uzávěry nebo pozorovatele, můžete implementovat zpracování událostí způsobem, který nejlépe vyhovuje potřebám vaší aplikace. Vyzkoušejte přidání událostí modelu do svého projektu Laravel ještě dnes a uvidíte, jak vám zjednoduší práci!