paulhenri-l/laravel-task-runner

Helps you compose command workflows as a set of tasks

3.1.1 2021-08-14 16:01 UTC

Requires

• php: ^7.3|^8.0
• laravel/framework: ^8.0

Requires (Dev)

• orchestra/testbench: ^6.0
• phpunit/phpunit: ^9.0

MIT

• paulhenri-l

README

This tool will help you run a defined set of tasks in your commands. It's useful in cases where your commands needs to consequently run different operations.

This tool is used inside both LaravelEngine and the PHL Console.

Example

php artisan my-command

[Some\Namespace\MyFirstTask]
Hello from MyFirstTask.

[Some\Namespace\MySecondTask]
MySecondTask Complete.

Installation done 🎉

Installation

composer require paulhenri-l/laravel-task-runner

Usage

In order to use the TaskRunner you need to add the CanRunTasks trait to your command and call the runTasks method.

The only argument is the array of tasks you want to run. A task is an invokable class. You can either pass instances of tasks or their classname.

If you pass in a classname the task will be resolved through laravel's container, so you can type hint any dependency you may need in your task's constructor.

Use the trait

<?php

class FakeCommand extends Illuminate\Console\Command
{
    use PaulhenriL\LaravelTaskRunner\CanRunTasks;

    protected $signature = 'my-command';

    /**
     * Execute the console command.
     */
    public function handle()
    {
        $this->runTasks([
            MyFirstTask::class,
            new MySecondTask()
        ]);

        $this->info('Installation done 🎉');
    }
}

Writing a task

<?php

use Illuminate\Console\Command;
use PaulhenriL\LaravelTaskRunner\TaskInterface;

class MyFirstTask implements TaskInterface
{
    public function __construct(SomeDependency $someDependency)
    {
        //
    }

    public function __invoke(Command $command)
    {
        $command->info('Hello from MyFirstTask.');
    }
}

Stop early

If you want to stop early you only need to return false from your task.

<?php

use Illuminate\Console\Command;
use PaulhenriL\LaravelTaskRunner\TaskInterface;

class SomeTask implements TaskInterface
{
    public function __invoke(Command $command)
    {
        if ($thereIsAnError) {
            return false;
        }
    }
}