https://github.com/parable-php/event
Parable Event is a straightforward and minimalist event system.
https://github.com/parable-php/event
event events hook listeners micro observers parable php8 triggers
Last synced: about 1 month ago
JSON representation
Parable Event is a straightforward and minimalist event system.
- Host: GitHub
- URL: https://github.com/parable-php/event
- Owner: parable-php
- License: mit
- Created: 2018-08-11T22:48:07.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2021-03-12T15:25:05.000Z (about 4 years ago)
- Last Synced: 2025-04-09T13:42:32.175Z (about 1 month ago)
- Topics: event, events, hook, listeners, micro, observers, parable, php8, triggers
- Language: PHP
- Homepage:
- Size: 25.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Parable Event
[](https://github.com/parable-php/event/actions?query=workflow%3ATests)
[](https://packagist.org/packages/parable-php/event)
[](https://packagist.org/packages/parable-php/event)
[](https://packagist.org/packages/parable-php/event)
Parable Event is a straightforward event system that gets the job done.
## Install
Php 8.0+ and [composer](https://getcomposer.org) are required.
```bash
$ composer require parable-php/event
```
## Usage
Events are very simple. You add listeners to events (`string` values) and then trigger an update with those events. You
can pass payloads into the `trigger` calls, which will get passed to all relevant listeners.
```php
use \Parable\Event\Events;
$eventManager = new Events();
$eventManager->listen('event_number_one', function (string $event, string &$payload) {
$payload .= '-updated!';
});
$payload = 'event';
$eventManager->trigger('event_number_one', $payload);
echo $payload;
// output: 'event-updated!'
```
The above example handily shows how to make scalar values modifiable by defining the parameter to the callable as a
reference. Passing objects is generally advisable, but sometimes it's the in-place alteration of string values you
need.
It's also possible to have a listener trigger on every single event.
```php
$eventManager->listenAll(function (string $event, $payload) {
echo $event . PHP_EOL;
});
```
The above example would simply log all events being updated. This can be handy for debugging, but can also be handy
to listen to a specific subset of events by matching the event, rather than adding a single listener to all individual
events.
## API
- `listen(string $event, callable $$listener): void` - add listener to an event
- `listenAll(callable $$listener): void` - add listener for all events
- `trigger(string $event, $payload): void` - trigger an update for an event
## Contributing
Any suggestions, bug reports or general feedback is welcome. Use github issues and pull requests, or find me over at [devvoh.com](https://devvoh.com).
## License
All Parable components are open-source software, licensed under the MIT license.