event

laravel event listener

Author: Mostafa Kamal

web-developer/laravel/tips/events.md

@@ -1,5 +1,128 @@
+---
+description: Event is a specific task and Listener listen a event then trigger one or many actions.
+keywords: laravel, php, event, listener
+title: Laravel Event Listener.
+toc_max: 4
+---
 
 
+* `Event` is a specific `task`.
+* `Listener` `listen` a `event` then `trigger` one or many `actions`.
+*  `Actions<- Listener <- listen (event)`
+
+```bash
+# generate from kernel
+php artisan event:generate
+# manually create
+php artisan make:listener ListenerName
+php artisan make:event EventName
+```
+
+# event
+
+* `EventName` class.
+
+```php
+
+namespace App\Events;
+
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Broadcasting\PrivateChannel;
+use Illuminate\Broadcasting\PresenceChannel;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
+use App\User;
+
+class EventName
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    public $user;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(User $user)
+    {
+        $this->user = $user;
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return new PrivateChannel('channel-name');
+    }
+}
+```
+
+# listen
+
+```php
+
+namespace App\Listeners;
+
+use App\Events\EventName;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Contracts\Queue\ShouldQueue;
+
+class ListenName
+{
+    /**
+     * Create the event listener.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        //
+    }
+
+    /**
+     * Handle the event.
+     *
+     * @param  EventName  $event
+     * @return void
+     */
+    public function handle(EventName $event)
+    {
+        return $event;
+    }
+}
+```
+
+# register
+
+* `app\Providers\EventServiceProvider.php`
+
+```php
+protected $listen = [
+    'App\Events\EventName' => [
+        'App\Listeners\ListenerName1',
+        'App\Listeners\ListenerName2',
+        'App\Listeners\ListenerNameALotOF',
+    ],
+];
+```
+
+# fire / dispatching
+
+```php
+use App\Events\OrderShipped;
+event(new EventName($order));
+```
+
+
+
+# Resources
 
 * [devlop video](https://www.youtube.com/watch?v=9oYtUEbT19I)
-* https://laravel.com/docs/5.7/events
+* [devlop queue event](https://www.youtube.com/watch?v=_SndYcQvIuQ)
+* [laravel.com](https://laravel.com/docs/5.7/events)