Zenstruck\ScheduleBundle\Schedule\Task\Result

Complexity

Total Complexity

18

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	isSuccessful()	0	3	1
A	skipped()	0	3	1
A	isException()	0	3	2
A	successful()	0	6	1
A	isFailure()	0	3	1
A	exception()	0	8	2
A	getDescription()	0	3	1
A	getTask()	0	3	1
A	getType()	0	3	1
A	getOutput()	0	3	1
A	failure()	0	6	1
A	__construct()	0	5	1
A	hasRun()	0	3	1
A	__toString()	0	3	1
A	isSkipped()	0	3	1
A	getException()	0	3	1

<?php

namespace Zenstruck\ScheduleBundle\Schedule\Task;

use Zenstruck\ScheduleBundle\Schedule\Task;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class Result
{
    public const SUCCESSFUL = 'successful';
    public const FAILED = 'failed';
    public const SKIPPED = 'skipped';

    /** @var Task */
    private $task;

    /** @var string */
    private $type;

    /** @var string */
    private $description;

    /** @var string|null */
    private $output;

    /** @var \Throwable|null */
    private $exception;

    private function __construct(Task $task, string $type, string $description)
    {
        $this->task = $task;
        $this->type = $type;
        $this->description = $description;
    }

    public function __toString(): string
    {
        return $this->getDescription();
    }

    public static function successful(Task $task, ?string $output = null, string $description = 'Successful'): self
    {
        $result = new self($task, self::SUCCESSFUL, $description);
        $result->output = $output;

        return $result;
    }

    public static function failure(Task $task, string $description, ?string $output = null): self
    {
        $result = new self($task, self::FAILED, $description);
        $result->output = $output;

        return $result;
    }

    public static function exception(Task $task, \Throwable $exception, ?string $output = null, ?string $description = null): self
    {
        $description = $description ?: \sprintf('%s: %s', (new \ReflectionClass($exception))->getShortName(), $exception->getMessage());

        $result = self::failure($task, $description, $output);
        $result->exception = $exception;

        return $result;
    }

    public static function skipped(Task $task, string $description): self
    {
        return new self($task, self::SKIPPED, $description);
    }

    public function getTask(): Task
    {
        return $this->task;
    }

    public function getType(): string
    {
        return $this->type;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function getOutput(): ?string
    {
        return $this->output;
    }

    public function getException(): ?\Throwable
    {
        return $this->exception;
    }

    public function isSuccessful(): bool
    {
        return self::SUCCESSFUL === $this->getType();
    }

    public function isFailure(): bool
    {
        return self::FAILED === $this->getType();
    }

    public function isException(): bool
    {
        return $this->isFailure() && $this->exception instanceof \Throwable;
    }

    public function isSkipped(): bool
    {
        return self::SKIPPED === $this->getType();
    }

    public function hasRun(): bool
    {
        return self::SKIPPED !== $this->getType();
    }
}