getting-started.md

Getting started

Vocabulary

Because when you start with any library it is important to understand what are the concepts introduced in it.

This is highly recommended that you read this entire page before starting to work with this library.

• Job: where you are going to work as a developer.
• Job Launcher: The entry point when you need to execute any job.
• Job Execution: The representation of a certain execution of certain job.
• Job Execution Storage: The persistence layer of jobs executions.

Quickstart example

<?php

declare(strict_types=1);

use Yokai\Batch\Factory\JobExecutionFactory;
use Yokai\Batch\Factory\UniqidJobExecutionIdGenerator;
use Yokai\Batch\Job\JobExecutionAccessor;
use Yokai\Batch\Job\JobExecutor;
use Yokai\Batch\Job\JobInterface;
use Yokai\Batch\JobExecution;
use Yokai\Batch\Launcher\SimpleJobLauncher;
use Yokai\Batch\Registry\JobContainer;
use Yokai\Batch\Registry\JobRegistry;
use Yokai\Batch\Serializer\JsonJobExecutionSerializer;
use Yokai\Batch\Storage\FilesystemJobExecutionStorage;

// you can instead use any psr/container implementation
// @see https://packagist.org/providers/psr/container-implementation
$container = new JobContainer([
    // here are the jobs you will want to write
    // each job has an identifier so it can be launched later
    'import' => new class implements JobInterface {
        public function execute(JobExecution $jobExecution): void
        {
            $fileToImport = $jobExecution->getParameter('path');
            // your import logic here
        }
    },
    'export' => new class implements JobInterface {
        public function execute(JobExecution $jobExecution): void
        {
            $exportSince = new DateTimeImmutable($jobExecution->getParameter('since'));
            // your export logic here
        }
    },
]);

$jobExecutionStorage = new FilesystemJobExecutionStorage(new JsonJobExecutionSerializer(), '/dir/where/jobs/are/stored');
$launcher = new SimpleJobLauncher(
    new JobExecutionAccessor(
        new JobExecutionFactory(new UniqidJobExecutionIdGenerator()), 
        $jobExecutionStorage
    ),
    new JobExecutor(
        new JobRegistry($container),
        $jobExecutionStorage,
        null // or an instance of \Psr\EventDispatcher\EventDispatcherInterface
    )
);

// now you can use $launcher to start any job you registered in $container

$importExecution = $launcher->launch('import', ['path' => '/path/to/file/to/import']);
$exportExecution = $launcher->launch('export', ['since' => '2020-07-03']);