Event & Listener

• Pengetahuan Dasar
• Menjalankan Event
• Me-listen Sebuah Event
• Antrian Event
• Framework Event

Pengetahuan Dasar

Event memberikan cara yang bagus untuk memecah keterkaitan resource dalam aplikasi anda, sehingga kelas, library ataupun plugin tidak akan tercampur dan mudah untuk diawasi.

Hal ini juga memungkinkan kelas, library dan plugin untuk memanfaatkan inti aplikasi anda tanpa mengubah kodenya.

Menjalankan Event

Untuk menjalankan event, cukup beritahukan nama event apa yang ingin anda jalankan:

Menjalankan sebuah event:

$responses = Event::fire('loaded');

Perhatikan bahwa kami menyimpan hasil dari metode fire() ke variabel $responses. Karena method fire() ini akan mereturn array yang berisi response dari semua listener milik si event.

Terkadang anda ingin menjalankan sebuah event, tetapi hanya ingin mengambil response pertamanya saja. Begini caranya:

Menjalankan sebuah event dan hanya mengambil response pertama saja:

$response = Event::first('loaded');

Note

Method first() ini akan tetap menjalankan seluruh listener yang dimiliki oleh si event, tetapi hanya response pertamanya saja yang akan direturn.

Sedangkan method Event::until() akan menjalankan seluruh listener yang dimiliki oleh si event, dan akan mereturn response pertama yang nilainya bukan NULL.

Menjalankan sebuah event dan mengambil response pertama yang bukan NULL:

$response = Event::until('loaded');

Me-listen Sebuah Event

Tetapi, apa gunanya membuat event jika ia tidak punya listener? Jadi, mari kita daftarkan sebuah contoh listener yang akan dipanggil ketika sebuah event dijalankan:

Mendaftarkan sebuah listener ke event bernama 'loaded':

Event::listen('loaded', function () {
    // Aku akan terpanggil ketika event 'loaded' dijalankan
});

Kode yang anda letakkan didalam Closure diatas akan terpanggil ketika event 'loaded' dijalankan.

Antrian Event

Terkadang anda mungkin hanya ingin "mengantrikan" suatu event untuk dijalankan diwaktu mendatang. Anda boleh melakukannya via method queue() dan flush().

Pertama, silahkan oper nama event ke parameter pertama, ingat! namanya harus unik agar tidak saling tumpang tindih:

Mengantrikan sebuah event:

Event::queue('foo', $user->id, [$user]);

Method ini menerima 3 parameter. Parameter pertama adalah nama antreannya, yang kedua adalah nama unik untuk item ini di antrean, dan yang ketiga adalah array data yang ingin dioper ke flusher.

Selanjutnya, kita akan mendaftarkan flusher untuk antrian bernama foo diatas:

Mendaftarkan sebuah event flusher:

Event::flusher('foo', function ($key, $user) {
    // ...
});

Perhatikan bahwa si flusher ini menerima 2 parameter. Pertama, nama unik dari event yang diantrikan, yang pada kasus diatas adalah user ID. Lalu parameter kedua (dan sisanya) akan menjadi item payload untuk antrian event.

Terakhir, kita sudah bisa menjalankan flusher dan mem-flush semua event yang diantrikan menggunakan method flush():

Event::flush('foo');

Framework Event

Berikut adalah beberapa event yang secara default akan dijalankan oleh rakit:

Event yang dijalankan ketika sebuah package di-boot:

Event::listen('rakit.booted: package', function () { });

Event yang dijalankan ketika sebuah query database dieksekusi:

Event::listen('rakit.query', function ($sql, $bindings, $time) { });

Event yang dijalankan tepat sebelum sebuah response dikirim ke browser:

Event::listen('rakit.done', function ($response) { });

Event yang dijalankan ketika sebuah pesan dicatat menggunakan kelas Log:

Event::listen('rakit.log', function ($type, $message) { });

Berikut adalah daftar lengkap event bawaan famework beserta parameter - parameternya. Anda dapat me-listen event - event berikut jika memang diperlukan: