Home

Awesome

PHP Event Dispatcher

Build Status codecov License: MIT

This package is designed as a part of Shieldon Firewall 2. You can also use it on your projects as well.

Installation

Use PHP Composer:

composer require shieldon/event-dispatcher

Or, download it and include the Shieldon autoloader.

require 'autoload.php';

Usage

Add a Listener

/**
 * @param string        $name      The name of an event.
 * @param string|array  $func      Callable function or class.
 * @param int           $priority  The execution priority.
 * 
 * @return bool
 */
\Shieldon\Event\Event::addLister(string $name, $func, int $priority = 10): bool

Please note, the priority must be unique. This method returns true when add a listener, false when the prirotiy has been taken by another listener.

Dispatch

/**
 * @param string $name The name of an event.
 * @param array  $args The arguments.
 * 
 * @return mixed
 */
\Shieldon\Event\Event::doDispatch(string $name, array $args = []): mixed

Return the filtered result, it's similar to WordPress' filter. You can ignore the return if you don't need that.

Example

Closure

Add a listener.

\Shieldon\Event\Event::addListener('test_1', function() {
    echo 'This is a closure function call.';
});

Dispatch.

$result = \Shieldon\Event\Event::doDispatch('test_1');

Function

Function for listener.

function test_event_disptcher()
{
    echo 'This is a function call.';
}

Add a listener.

\Shieldon\Event\Event::addListener('test_2', 'test_event_disptcher');

Dispatch.

$result = \Shieldon\Event\Event::doDispatch('test_2');

Class

Add a listener.

$example = new Example();

\Shieldon\Event\Event::addListener('test_3', [$example, 'example1']);

Dispatch.

$result = \Shieldon\Event\Event::doDispatch('test_3');

Hope this helps.

Author

License

MIT