Mongolid\Event\EventTriggerService::fire PHP Method

fire() public method

Triggers / Dispatches a new event to the registered event handlers if they have been registered.
public fire ( string $event, mixed $payload, boolean $halt = false ) : 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
    public function fire(string $event, $payload, bool $halt = false)
    {
        if ($this->dispatcher) {
            return $this->dispatcher->fire($event, $payload, $halt);
        }
        return true;
    }

Usage Example

 public function testShouldReturnTrueIfThereIsNoExternalDispatcher()
 {
     // Arrange
     $dispatcher = m::mock(EventTriggerInterface::class);
     $service = new EventTriggerService();
     // Act
     $dispatcher->shouldReceive('fire')->never();
     // Assertion
     /* without calling registerEventDispatcher */
     $this->assertTrue($service->fire('foobar', ['answer' => 23], true));
 }
All Usage Examples Of Mongolid\Event\EventTriggerService::fire