Subway

, _(*1)

Nuclear reactor powered background job processing for PHP., _(*2)

Features

Delayed jobs
Repeating jobs
Resque compatible db
Configurable logging
Supports composer and symfony based apps out-of-box

Requirements

A POSIX-oriented operating system (No windows support due to pcntl dependency)
PHP >= 5.4 (with pcntl)
Redis

Installation

Add Subway in your composer.json:, _(*3)

{
    "require": {
        "eo/subway": "dev-master"
    }
}

Now tell composer to download the bundle by running the command:, _(*4)

$ php composer.phar update eo/subway

Composer will install everything into your project's vendor directory., _(*5)

Usage

Creating job classes

To create a new job, extend your job class to Subway\Job and implement abstract method perform., _(*6)

<?php

use Subway\Job;

class MyAwesomeJob extends Job
{
    public function perform()
    {
        // do something here
    }
}

Queueing jobs

<?php

use Predis\Client;
use Subway\Factory;

$redis  = new Client();
$subway = new Factory($redis);

$message = new Message('default', 'Subway\Tests\Job\Md5Job', array('hello' => 'world'));
$id = $this->factory->enqueue($message);

echo "Job $id enqueued!";

If you need to enqueue Message only once use enqueueOnce method., _(*7)

Executing jobs

To execute jobs you can either use the binary file distributed with this library (see bin directory) or download the latest .phar archive from: http://eymengunay.github.io/subway/downloads/subway-latest.phar, _(*8)

Once you have located the binary or downloaded .phar archive start your worker using the following command:, _(*9)

php subway.phar worker

To see all available options and arguments see command help:, _(*10)

php subway.phar worker -h

Commands

command	description
clear	Clear subway database
help	Displays help for a command
init	Create a new subway configuration file
list	Lists commands
sample	Loads sample jobs
self-update	Updates subway.phar to the latest version
status	Show subway status
worker	Starts a subway worker