masrodjie/codeigniter3-queue

The Illuminate Queue package for CodeIgniter 3

v1.0.2 2023-03-03 16:52 UTC

Requires

• php: ^7.3|^8.0
• illuminate/events: ^8.83
• illuminate/queue: ^8.83
• illuminate/redis: ^8.83
• predis/predis: ^2.1

Requires (Dev)

• phpunit/phpunit: ^8.5

MIT

• masrodjie

• redis
• queue
• job
• worker
• codegniter3
• codeigniter3-queue

README

Instalation

Include this package via Composer:

composer require masrodie/codeigniter3-queue

Setup services queue

Add redis config in .env. You can use dotenv package https://github.com/vlucas/phpdotenv

REDIS_SCHEME=tcp
REDIS_HOST=localhost
REDIS_CLIENT=predis
REDIS_USERNAME=
REDIS_PASSWORD=null
REDIS_PORT=6379
REDIS_SCHEME=tcp
REDIS_DB=0

Update composer.json

"autoload": {
    "psr-4": {
        "App\\":"application"
    }
}

Run

composer dump-autoload

Usage

Example job

<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;

class SendEmail implements ShouldQueue
{

    use InteractsWithQueue, Queueable, SerializesModels;

    public function fire($e, $payload) {
        $this->onQueue('processing');
        echo "FIRE\n";

        $ci=&get_instance();
        $ci->load->library('email');

        $ci->email->from('[e-mail]', 'Your Name');
        $ci->email->to($payload['to']);

        $ci->email->subject('Email Test');
        $ci->email->message('Testing the email class.');

        $ci->email->send();
        
        $e->delete();
    }

}

Create queue worker controller

<?php if(!defined('BASEPATH')) exit('No direct access script allowed');

class Queue extends CI_Controller {
 
    public function work() {
        $queue = new Masrodjie\Queue\Libraries\Queue();
        $dispatcher = new Illuminate\Events\Dispatcher();
        $exception = new \Masrodjie\Queue\Exceptions\Handler();
        $isDownForMaintenance = function () {
            return false;
        };
        $worker = new Illuminate\Queue\Worker($queue->getQueueManager(), $dispatcher, $exception, $isDownForMaintenance, null);
        $options = new Illuminate\Queue\WorkerOptions();
        $options->maxTries = 5;
        $options->timeOut = 300;
        $worker->daemon('redis', 'default', $options);
    }
    
}

How to use in controller

<?php if(!defined('BASEPATH')) exit('No direct access script allowed');

class Test extends CI_Controller {
{
    public function index()
    {
        $queue = new Masrodjie\Queue\Libraries\Queue();
        $queue->push('\App\Jobs\SendEmail', ['to' => '[e-mail]']);
    }
}

Run queue worker

php index.php queue/work

More info usefull link docs laravel

• Queues: Getting Started

License

This package is free software distributed under the terms of the MIT license.