argon/event

Library for event-based development in PHP

dev-master 2019-08-20 17:14 UTC

This package is auto-updated.

Last update: 2024-09-26 14:26:26 UTC


README

Library for event-based development in PHP.

Build Status Code Climate coverage Code Climate maintainability Code Style PSR-1 Code Style PSR-2 License

How to install

The package can be easly installed using composer, with the following command:

composer require argon/event:dev-master

Getting started (basic)

The most basic way of using Argon/Event is to create a new instance of EventManger and using it. The code bellow shows how it can be done:

<?php

require "vendor/autoload.php";

use Argon\Event\EventManager;

$eventManager = new EventManager();

$eventManager->on('eventName', function() {
    echo "This message was triggered by eventName!";
});

$eventManager->fire('eventName');

Getting started (advanced)

An most advanced way of using Argon/Event is using the EventTrait and incorporate the functionality inside your own class. The code bellow will gives you some ideas:

<?php

require "vendor/autoload.php";

use Argon\Event\EventTrait;

final class MyEventManager
{
    use EventTrait;
    
    public function myOwnNewMethod()
    {
        echo "Hello World!";
    }
}

$myEventManager = new MyEventManager();

$myEventManager->on('eventName', function() {
    echo "This message was triggered by eventName!";
});

$myEventManager->fire('eventName');

As you can see, using the EventTrait is possible to incorporate all the behavior of the EventManager inside your own class.