File: README.md

Recommend this page to a friend!
  Classes of Kiril Savchev  >  ITE Event Manager  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: ITE Event Manager
Manage events implementing PSR-14 interface
Author: By
Last change: Fill readme with examples
Date: 3 years ago
Size: 4,066 bytes
 

Contents

Class file image Download

If-Then-Else Event Manager package

Description

Set of classes the can be used for managing events (publish/subscribe pattern). It also provides a trait for attaching, triggering and removing event listeners within a custom class more in javascript style, turning this class into event manager itself.

NOTE: The psr interfaces are not part of this package, but are included for tests purposes. If you want to use them anyway, you must add their namespace and path to composer.json's autoload section.

This package implements PSR-14 (DRAFT) standards. See https://github.com/php-fig/fig-standards/blob/master/proposed/event-manager.md for more information.

Usage

You can see the examples in the 'tests' folder

Event manager example:

<?php

use Ite\EventManager\Event;
use Ite\EventManager\EventManager;

chdir(realpath(__DIR__.'/..'));

require_once './vendor/autoload.php';

// load psr interfaces if they not exists
// (not part of this package, but included for convenience):
if (!interface_exists('Psr\\EventManager\\EventInterface')) {
        require_once './psr/event-manager/EventInterface.php';
}
if (!interface_exists('Psr\\EventManager\\EventManagerInterface')) {
        require_once './psr/event-manager/EventManagerInterface.php';
}

# Create some callbacks:
$callback1 = function(Event $e) {
        echo $e->getName().PHP_EOL;
};

$callback2 = function (Event $e) {
        var_dump($e->getParams());
        // return result to the trigger
        return 1;
};
$callback3 = function (Event $e, $result) {
        // get the result, returned by the events and dump it:
        var_dump($result);
        // This callback will stop the event triggering
        $e->stopPropagation(1);
};

$callback4 = function (Event $e) {
        var_dump($e);
};

// initiate the event manager
$eventManager = new EventManager();
// attach the callbacks:
$eventManager->attach('TestEvent', $callback1);
$eventManager->attach('TestEvent', $callback2);
$eventManager->attach('TestEvent', $callback3);
$eventManager->attach('TestEvent', $callback4);
// trigger the TestEvent. After $callback3 the triggering will be stopped
// and $callback4 won't be called:
$eventManager->trigger('TestEvent', null, ['a' => 1, 'b' => 2]);

// remove $callback3
$eventManager->detach('TestEvent', $callback3);
// trigger the TestEvent again. This time $callback4 will be called:
$eventManager->trigger('TestEvent', null, ['a' => 1, 'b' => 2]);
// attach to second event:
$eventManager->attach("Event2", $callback1);
$eventManager->attach("Event2", $callback4);
// trigger the second event:
$eventManager->trigger("Event2");

Event listener manager example:

<?php

use Ite\EventManager\EventListenerManagerInterface;
use Ite\EventManager\EventListenerManagerTrait;
use Ite\EventManager\EventManager;
use Psr\EventManager\EventInterface;

chdir(realpath(__DIR__.'/..'));

require_once './vendor/autoload.php';

// load psr interfaces if they not exists
// (not part of this package, but included for convenience):
if (!interface_exists('Psr\\EventManager\\EventInterface')) {
        require_once './psr/event-manager/EventInterface.php';
}
if (!interface_exists('Psr\\EventManager\\EventManagerInterface')) {
        require_once './psr/event-manager/EventManagerInterface.php';
}

class EventManagerAwareTests implements EventListenerManagerInterface {

        use EventListenerManagerTrait;

        protected $checks = 'asd';

}

$manager = new EventManagerAwareTests();
$manager->setEventManager(new EventManager());

$manager->addEventListener('TestEvent', function (EventInterface $e) {
        var_dump($e, $this->checks); // will dump the event object and 'asd'
}, 0, true);

$manager->fire('TestEvent', $manager);

For more information send a message to info at phpclasses dot org.