foxphp/event-dispatcher

A simple event dispatcher in PHP

0.1.0 2021-06-22 21:01 UTC

Requires

• php: ^8.0

Requires (Dev)

• pestphp/pest: ^1.7
• spatie/ray: ^1.26
• vimeo/psalm: ^4.8

MIT

• Steve McDougall

README

A simple event dispatcher in PHP.

Installation

To install this package you can use composer:

composer require foxphp/event-dispatcher

Usage

// Create a new dispatcher

$dispatcher = Dispatcher::make(
    listeners: [
        Path\To\Event::class => [
            Path\To\Listener::class,
        ]
    ]
);

$dispatcher = new Dispatcher(
    listeners: [],
    log: []
);

// Add event with listeners
$dispatcher->add(
    event: Path\To\Event::class,
    listeners: [
        Path\To\Listener::class,
    ]
);

// Append listeners onto an event listener array
$dispatcher->append(
    event: Path\To\Event::class,
    listeners: [
        Path\To\Another\Listener::class,
    ]
);

// Dispatch
$dispatcher->dispatch(
    event: new Path\To\Event(),
    debug: true,
);

// Get debug log items
$dispatcher->log(); // []