Download the PHP package lithemod/events without Composer
On this page you can find all versions of the php package lithemod/events. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lithemod/events
More information about lithemod/events
Files in lithemod/events
Package events
Short Description Lithe Events: A powerful and lightweight event management system for PHP projects, designed to simplify communication between components intuitively and efficiently. Easily create, register, and emit events, making your code more modular and reactive. Transform your applications into dynamic experiences with Lithe Events!
License MIT
Informations about the package events
Lithe Events
Lithe Events is a lightweight event handling library designed for PHP applications. It provides a straightforward way to create and manage events, supporting a decoupled architecture that enhances the maintainability and flexibility of your applications.
Table of Contents
- Installation
- Usage
- Using the EventDispatcher Class
- Creating an Event
- Registering Listeners
- Emitting Events
- Removing Listeners
- Using Orbis Event Functions
- Example
- License
Installation
To install lithemod/events
, use Composer. Run the following command in your project directory:
This command will download the package and update your composer.json
file accordingly.
Usage
Using the EventDispatcher Class
The EventDispatcher
class serves as the core for managing events and listeners. Here's how to use it effectively:
Creating an Event
To create an event, instantiate the Event
class:
- Parameters:
event.name
: A string that identifies the event.['key' => 'value']
: An optional associative array to store additional event data.
Registering Listeners
You can create an instance of EventDispatcher
and register a listener for an event using the on
method. A listener is a callable executed when the event is emitted.
Emitting Events
To emit an event and trigger all registered listeners, use the emit
method:
Removing Listeners
If you need to remove a listener from an event, use the off
method:
Using Orbis Event Functions
In addition to using the EventDispatcher
, you can utilize helper functions provided by the Orbis
namespace for convenient event management.
Registering Listeners
To register a listener for an event using Orbis, use the on
function:
Emitting Events
To emit an event using Orbis, call the emit
function:
Removing Listeners
To remove a registered listener with Orbis, use the off
function:
Example
Here's a complete example of how to use lithemod/events
with the Orbis
event functions:
License
This project is licensed under the MIT License.