Events

• Definition
• Principles
• Rules
• Folder Structure
• Usage
• Broadcasting

Definition

• Events provide a simple observer implementation, allowing you to subscribe and listen for various events that occur in your application.
• Events are classes that can be fired from anywhere in your application.
• An event class will usually be bound to one, or many Events Listeners Classes or has those Listeners registered to listen to it.
• "fire" is the term that is usually used to call an Event.

Principles

• Events can be fired from Actions and or Tasks. It's preferable to choose one place only. (Tasks are recommended).
• Events SHOULD be created inside the Containers. However, general Events CAN be created in the Ship layer.

Rules

• Event classes CAN be placed inside the Containers in Events folders or on the Ship for the general Events.
• All Events MUST extend from App\Ship\Parents\Events\Event.

Folder Structure

- App
  - Containers
    - {section-name}
      - {container-name}
        - Events
          - SomethingHappenedEvent.php
          - ...
        - Listeners
          - ListenToMusicListener.php
          - ...

  - Ship
    - Events
      - GlobalStateChanged.php
      - SomethingBiiigHappenedEvent.php
      - ...

Usage

In Laravel, you can create and register events in multiple way. Read Laravel documentation to learn more about Events.

Your custom EventServiceProvider needs to be registered in the containers MainServiceProvider as well.

Broadcasting

To define Broadcasting route go to app/Ship/Boardcasts/Routes.php.

Further reading

More info at Laravel Docs.