Download the PHP package mle86/wq without Composer
On this page you can find all versions of the php package mle86/wq. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package wq
Short Description A simple library for work-queue and job handling.
License MIT
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 wq
WQ (mle86/wq)
This package provides an easy way to put PHP tasks of any kind into a work queue such as Beanstalkd or Redis to execute them at a later time.
This is version 0.21.1.
Installation and Dependencies
It requires PHP 8.0+ and has no other dependencies (apart from PHPUnit/Coveralls for development and the PSR-3 interfaces).
Adapter Implementations
You'll also want to install at least one other package
which contains a WorkServerAdapter implementation,
such as:
- mle86/wq-beanstalkd (Beanstalkd server adapter),
- mle86/wq-redis (Redis server adapter),
- mle86/wq-amqp (RabbitMQ server adapter).
Basic Concepts
-
A Job is something which should be done exactly once. Maybe it's sending an e-mail, maybe it's an external API call like a webhook, maybe it's some slow clean-up process. In any case, we're talking about a unit of work that could be executed right away but it would be better for the application's performance to put it in a Work Queue instead, so it can be done asynchronously.
- A Work Queue is a list of jobs that should be executed at some other time. They are stored in some kind of Work Server. One work server well-known in the PHP world is Beanstalkd. It can store any number of work queues, although it calls them “tubes”.
Different work queues, or tubes, are commonly used to separate job types.
For example, the same work server might have
one “mail” queue for outgoing mails to be sent,
one “cleanup” queue for all kinds of clean-up jobs,
and one “webhook” queue for outgoing web-hook calls.
This package provides some helpful classes to set up a simple work queue system.
Quick Start
This is our Job implementation. It represents an e-mail that can be sent.
We have some code using that e-mail class:
And finally, we have our background worker script which regularly checks the work server for new e-mail jobs:
Documentation
- Implementing a Job class
- Execute or Queue
- Work the Queue
- Error Handling
- Usage Examples
Class reference:
- Job interface
- AbstractJob base class
- QueueEntry wrapper class
- WorkServerAdapter interface
- AffixAdapter wrapper class
- BlackHoleWorkServer dummy class
- WorkProcessor class
- SignalSafeWorkProcessor class
- JobResult enum class
- JobContext dto class
- Exceptions
