Download the PHP package olvlvl/delayed-event-dispatcher without Composer
On this page you can find all versions of the php package olvlvl/delayed-event-dispatcher. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download olvlvl/delayed-event-dispatcher
More information about olvlvl/delayed-event-dispatcher
Files in olvlvl/delayed-event-dispatcher
Package delayed-event-dispatcher
Short Description Delays the dispatching of events
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package delayed-event-dispatcher
Delayed event dispatcher
The olvlvl/delayed-event-dispatcher package provides an event dispatcher that delays event dispatching to a later time
in the application life.
A delayed event dispatcher is useful to reduce the response time of your HTTP application when events can perfectly be dispatched after the response has been sent. For instance, updating an entity that would require clearing cache, performing projections, or reindexing, all of which have nothing to do with the response itself. Delayed events are dispatched when flushed, but you can choose another solution entirely, like sending them to consumers using RabbitMQ or Kafka.
Because you're probably using one event dispatcher for your application you don't want all events to be delayed, some of them have to be dispatched immediately for your application to run properly, that's why you can specify an arbiter to determine which events to delay and which not to.
Finally, because you want all delayed events to be dispatched when you flush them—even when an exception is thrown—you can provide an exception handler. It's up to you to decide what to do. You'll probably want to recover, log the exception, and continue with dispatching the other events.
Disclaimer: The delayed event dispatcher is a decorator that is meant to be used together with psr/event-dispatcher.
Instantiating a delayed event dispatcher
The delayed event dispatcher is a decorator, which means you'll need another event dispatcher to decorate.
Instantiating an inactive delayed event dispatcher
By default the delayed event dispatcher is active, which means it will delay events. This is fine for your HTTP
application, but that's not something you want for the console or the consumer application. You can create a disabled
delayed event dispatcher be defining the disabled option as true.
This is especially useful when your HTTP/console/consumer applications are deployed using the same artifact, that you can customize using environment variables.
Flushing delayed events
Delayed events are flushed (dispatched) with the flush() method.
Flushing delayed events with a custom flusher
By default, events are dispatched with the decorated event dispatcher when flushed, but you can choose another solution entirely, like sending them to consumers using RabbitMQ or Kafka.
Deciding which events to delay and which not to
By default all events are delayed—if the delayed event dispatcher was created with disabled = false—but you can supply
an arbiter to choose which events to delay and which not to. You can use the Delayable interface to mark your events,
but it's not a requirement. The arbiter is a simple callable, its implementation is up to you.
Handling exceptions
By default exceptions thrown during the dispatching of events are not recovered, the dispatching halts, leaving delayed events in the queue. If you want to recover from these exceptions, and make sure all the events are dispatched, you'll want to provide and exception handler.
Requirements
The package requires PHP 7.2 or later.
Installation
The recommended way to install this package is through Composer:
$ composer require olvlvl/delayed-event-dispatcherCloning the repository
The package is available on GitHub, its repository can be cloned with the following command line:
$ git clone https://github.com/olvlvl/delayed-event-dispatcher.gitDocumentation
You can generate the documentation for the package and its dependencies with the make doc command.
The documentation is generated in the build/docs directory. ApiGen is
required. The directory can later be cleaned with the make clean command.
Testing
The test suite is ran with the make test command. PHPUnit and
Composer need to be globally available to run the suite. The command
installs dependencies as required. The make test-coverage command runs test suite and also creates
an HTML coverage report in build/coverage. The directory can later be cleaned with the
make clean command.
The package is continuously tested by Travis CI.
License
olvlvl/delayed-event-dispatcher is licensed under the New BSD License - See the LICENSE file for details.
