Skip to content
🐘 PHP library to run and orchestrate background jobs with Zenaton.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Run tests against PHP 7.3 Mar 25, 2019
src/Zenaton Start next development version Jun 4, 2019
tests
.editorconfig Update editorconfig file Nov 30, 2018
.gitignore Fix code style using PHP CS Fixer Sep 4, 2018
.php_cs.dist Fix some coding style Nov 30, 2018
CHANGELOG.md Start next development version Jun 4, 2019
LICENSE Add LICENSE file Oct 23, 2018
README.md Add target _blank on header links May 23, 2019
UPGRADE.md Fix a typo in UPGRADE.md file May 23, 2019
composer.json Remove dependency vlucas/phpdotenv May 31, 2019
phpunit.xml.dist

README.md


Easy Asynchronous Jobs Manager for Developers
Explore the docs »
Website · Examples in PHP · Tutorial in PHP

Packagist CircleCI License

Zenaton library for PHP

Zenaton helps developers to easily run, monitor and orchestrate background jobs on your workers without managing a queuing system. In addition to this, a monitoring dashboard shows you in real-time tasks executions and helps you to handle errors.

The Zenaton library for PHP lets you code and launch tasks using Zenaton platform, as well as write workflows as code. You can sign up for an account on Zenaton and go through the tutorial in PHP.

PHP Documentation

You can find all details on Zenaton's website.

Table of contents

Getting started

Installation

Install the Zenaton Agent

To install the Zenaton agent, run the following command:

curl https://install.zenaton.com/ | sh

Then, you need your agent to listen to your application. To do this, you need your Application ID and API Token. You can find both on your Zenaton account.

zenaton listen --app_id=YourApplicationId --api_token=YourApiToken --app_env=YourApplicationEnv

Install the library

To add the latest version of the library to your project, run the following command:

composer require zenaton/zenaton-php

Framework integration

If you are using Laravel or Symfony, please refer to our dedicated documentation to get started:

Quick start

Client Initialization

To start, you need to initialize the client. To do this, you need your Application ID and API Token. You can find both on your Zenaton account.

Then, initialize your Zenaton client:

Zenaton\Client::init('YourApplicationId', 'YourApiToken', 'YourApplicationEnv');

Executing a background job

A background job in Zenaton is a class implementing the Zenaton\Interfaces\TaskInterface interface.

Let's start by implementing a first task printing something, and returning a value:

use Zenaton\Interfaces\TaskInterface;
use Zenaton\Traits\Zenatonable;

class HelloWorldTask implements TaskInterface
{
    public function handle()
    {
        echo "Hello World\n";

        return mt_rand(0, 1);
    }
}

Now, when you want to run this task as a background job, you need to do the following:

(new HelloWorldTask())->dispatch();

That's all you need to get started. With this, you can run many background jobs. However, the real power of Zenaton is to be able to orchestrate these jobs. The next section will introduce you to job orchestration.

Orchestrating background jobs

Job orchestration is what allows you to write complex business workflows in a simple way. You can execute jobs sequentially, in parallel, conditionally based on the result of a previous job, and you can even use loops to repeat some tasks.

We wrote about some use-cases of job orchestration, you can take a look at these articles to see how people use job orchestration.

Using workflows

A workflow in Zenaton is a class implementing the Zenaton\Interfaces\WorkflowInterface interface.

We will implement a very simple workflow:

First, it will execute the HelloWorld task. The result of the first task will be used to make a condition using an if statement. When the returned value will be greater than 0, we will execute a second task named FinalTask. Otherwise, we won't do anything else.

One important thing to remember is that your workflow implementation must be idempotent. You can read more about that in our documentation.

The implementation looks like this:

use Zenaton\Interfaces\WorkflowInterface;
use Zenaton\Traits\Zenatonable;

class MyFirstWorkflow implements WorkflowInterface
{
    use Zenatonable;

    public function handle()
    {
        $n = (new HelloWorldTask())->execute();
        if ($n > 0) {
            (new FinalTask())->execute();
        }
    }
}

Now that your workflow is implemented, you can execute it by calling the dispatch method:

(new MyFirstWorkflow())->dispatch();

If you really want to run this example, you will need to implement the FinalTask task.

There are many more features usable in workflows in order to get the orchestration done right. You can learn more in our documentation.

Getting help

Need help? Feel free to contact us by chat on Zenaton.

Found a bug? You can open a GitHub issue.

You can’t perform that action at this time.