PHP Class MongolidLaravel\LaravelEventTrigger

Inheritance: implements Mongolid\Event\EventTriggerInterface
Datei anzeigen Open project: leroy-merlin-br/mongolid-laravel Class Usage Examples

Protected Properties

Property Type Description
$dispatcher Illuminate\Contracts\Events\Dispatcher Laravel's Event dispatcher.

Public Methods

Method Description
__construct ( Illuminate\Contracts\Events\Dispatcher $dispatcher ) Injects a Laravel's event dispatcher instance.
fire ( string $event, mixed $payload, boolean $halt ) : mixed Triggers / Dispatches a new event to the event handlers or listeners that are being used.

Method Details

__construct() public method

Injects a Laravel's event dispatcher instance.
public __construct ( Illuminate\Contracts\Events\Dispatcher $dispatcher )
$dispatcher Illuminate\Contracts\Events\Dispatcher Event dispatcher.

fire() public method

Triggers / Dispatches a new event to the event handlers or listeners that are being used.
public fire ( string $event, mixed $payload, boolean $halt ) : mixed
$event string Identification of the event.
$payload mixed Data that is going to be sent to the event handler.
$halt boolean The output of the event handler will be used in a conditional inside the context of where the event is being fired. This means that, if the event handler returns false, it will probably stop the action being executed, for example, "saving".
return mixed Event handler return. The importance of this return is determined by $halt

Property Details

$dispatcher protected_oe property

Laravel's Event dispatcher.
protected Dispatcher,Illuminate\Contracts\Events $dispatcher
return Illuminate\Contracts\Events\Dispatcher