Download the PHP package wired00/custom-queue without Composer
On this page you can find all versions of the php package wired00/custom-queue. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 custom-queue
Laravel Custom Queues
Laravel queues work great internally when jobs are both pushed (SomeJob::dispatch()) and then fetched via Laravel queue workers.
But what if jobs are pushed to a queue from an external service or message broker other than Laravel? For example, AWS S3 bucket > SNS > SQS? In those cases, Laravel queue workers do not recognise the payload, cannot parse it and break because the job payload is missing the expected job and data attributes etc.
CustomQueue aims to solve this issue. It will fetch a job, re-packages the payload to a format which Laravel recognises and then process via a user specified job handler.
Payload without custom-queue:
Payload with custom-queue:
Note: job: custom-sqs is designating a job handler to be used to process the job. data is simply the original payload.
Installation
Install package via composer
Publish the CustomQueue config file into your project
See details on configuring customqueue.php below
Usage
Configuration
queue.php
Setup a custom external SQS connection
Set all these values from your Laravel .env. I.e:
customqueue.php
customqueue.php config file simply contains a mapping between handler class path and an identifier.
The example contains identifier custom-sqs and class path App\Jobs\ProcessSQS::class. This specifies that the job payload when fetched from a queue will be appended with a key-value of job: App\Jobs\ProcessSQS::class whenever a connection type of custom-sqs is processed. The job will then process via ProcessSQS->handle().
Currently CustomQueue only supports custom SQS fetching but in future it might support RabbitMQ and Redis. In those cases customqueue.php would include identifiers such as custom-redis and custom-rabbitmq.
Handler files
Handler files are those referenced via the class path within customqueue.php. They must implement Wired00\CustomQueue\Contracts\CustomQueueJobHandler.
A common namespace for these are App\Jobs.
For example:
Note:
-
handle()accepts the current job and importantly$datawhich contains the job payload popped from the SQS queue for example. $job->delete();might be needed depending on how the queue handles things. In my case,SQSdid not seem to auto remove jobs after they were fetched. Sodelete()was required to remove the job after handling.
License
This is built upon the unmaintained, and non-functional, Laravel External Queue package (kristianedlund/laravel-external-queue)
It is of MIT license do what you want with it. All care no responsibility. MIT license.
All versions of custom-queue with dependencies
aws/aws-sdk-php Version ~3.3
illuminate/queue Version ~5.0
ext-json Version *