Cerbero\ConsoleTasker\Tasks\InvalidTask

Complexity

Total Complexity

7

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	shouldRollbackDueTo()	0	3	1
A	getPurpose()	0	3	1
A	getClass()	0	3	1
A	getError()	0	7	2
A	run()	0	3	1
A	__construct()	0	3	1

<?php

namespace Cerbero\ConsoleTasker\Tasks;

/**
 * An invalid task.
 *
 */
class InvalidTask extends AbstractTask
{
    /**
     * The invalid task class.
     *
     * @var string
     */
    protected $class;

    /**
     * Construct the class
     *
     * @param string $class
     */
    public function __construct(string $class)
    {
        $this->class = $class;
    }

    /**
     * Run the task
     *
     * @return mixed
     */
    public function run()
    {
        return false;
    }

    /**
     * Set the invalid task class
     *
     * @param string $class
     * @return self
     */
    public function getClass(): string
    {
        return $this->class;
    }

    /**
     * Retrieve this task purpose
     *
     * @return string
     */
    public function getPurpose(): string
    {
        return class_basename($this->class);
    }

    /**
     * Retrieve the error that caused this task to fail
     *
     * @return string|null
     */
    public function getError(): ?string
    {
        if ($e = $this->getException()) {
            return $e->getMessage();
        }

        return "The item [{$this->class}] is not a valid task";
    }

    /**
     * Determine whether this task should rollback if the given task fails
     *
     * @param AbstractTask|null $task
     * @return bool
     */
    public function shouldRollbackDueTo(?AbstractTask $task): bool
    {
        return false;
    }
}