AnimeDb\Bundle\AppBundle\Entity\Task

Complexity

Total Complexity

24

Size/Duplication

Total Lines	233
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

94.64%

Importance

Changes	2
Bugs	0	Features	0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getId()	0	4	1
A	setLastRun()	0	5	1
A	getLastRun()	0	4	2
A	setNextRun()	0	5	1
A	getNextRun()	0	4	1
A	setModify()	0	5	1
A	getStatus()	0	4	1
A	getStatuses()	0	7	1
A	__construct()	0	4	1
A	setCommand()	0	5	1
A	getCommand()	0	4	1
A	getModify()	0	4	1
A	setStatus()	0	5	1
A	setInterval()	0	7	2
A	isModifyValid()	0	9	3
B	executed()	0	20	5

<?php
/**
 * AnimeDb package
 *
 * @package   AnimeDb
 * @author    Peter Gribanov <info@peter-gribanov.ru>
 * @copyright Copyright (c) 2011, Peter Gribanov
 * @license   http://opensource.org/licenses/GPL-3.0 GPL v3
 */

namespace AnimeDb\Bundle\AppBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Context\ExecutionContextInterface;

/**
 * Task for Task Scheduler
 *
 * @ORM\Entity
 * @ORM\Table(name="task", indexes={
 *   @ORM\Index(name="idx_task_next_start", columns={"next_run", "status"})
 * })
 * @Assert\Callback(methods={"isModifyValid"})
 * @ORM\Entity(repositoryClass="AnimeDb\Bundle\AppBundle\Repository\Task")
 *
 * @package AnimeDb\Bundle\AppBundle\Entity
 * @author  Peter Gribanov <info@peter-gribanov.ru>
 */
class Task
{
    /**
     * @var int
     */
    const STATUS_ENABLED = 1;

    /**
     * @var int
     */
    const STATUS_DISABLED = 0;

    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     *
     * @var int
     */
    protected $id;

    /**
     * @ORM\Column(type="string", length=128)
     *
     * @var string
     */
    protected $command = '';

    /**
     * @ORM\Column(type="datetime", nullable=true)
     * @Assert\DateTime()
     *
     * @var \DateTime|null
     */
    protected $last_run;

    /**
     * @ORM\Column(type="datetime")
     * @Assert\DateTime()
     *
     * @var \DateTime
     */
    protected $next_run;

    /**
     * A date/time string
     *
     * Valid formats are explained in Date and Time Formats.
     *
     * @link http://www.php.net/manual/en/datetime.formats.php
     * @ORM\Column(type="string", length=128, nullable=true)
     *
     * @var string
     */
    protected $modify = '';

    /**
     * @ORM\Column(type="integer")
     * @Assert\Choice(callback = "getStatuses")
     *
     * @var int
     */
    protected $status = self::STATUS_DISABLED;

    public function __construct()
    {
        $this->next_run = new \DateTime();
    }

    /**
     * @param string $command
     *
     * @return Task
     */
    public function setCommand($command)
    {
        $this->command = $command;
        return $this;
    }

    /**
     * @return string
     */
    public function getCommand()
    {
        return $this->command;
    }

    /**
     * @return int
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param \DateTime $last_run
     *
     * @return Task
     */
    public function setLastRun(\DateTime $last_run)
    {
        $this->last_run = clone $last_run;
        return $this;
    }

    /**
     * @return \DateTime|null
     */
    public function getLastRun()
    {
        return $this->last_run ? clone $this->last_run : null;
    }

    /**
     * @param \DateTime $next_run
     *
     * @return Task
     */
    public function setNextRun(\DateTime $next_run)
    {
        $this->next_run = clone $next_run;
        return $this;
    }

    /**
     * @return \DateTime
     */
    public function getNextRun()
    {
        return clone $this->next_run;
    }

    /**
     * @param int $interval
     *
     * @return Task
     */
    public function setInterval($interval)
    {
        if ($interval > 0) {
            $this->setModify(sprintf('+%s second', (int)$interval));
        }
        return $this;
    }

    /**
     * @param string $modify
     *
     * @return Task
     */
    public function setModify($modify)
    {
        $this->modify = $modify;
        return $this;
    }

    /**
     * @return string
     */
    public function getModify()
    {
        return $this->modify;
    }

    /**
     * @param int $status
     *
     * @return Task
     */
    public function setStatus($status)
    {
        $this->status = $status;
        return $this;
    }

    /**
     * @return int
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * @return int[]
     */
    public static function getStatuses()
    {
        return [
            self::STATUS_DISABLED,
            self::STATUS_ENABLED
        ];
    }

    /**
     * @param ExecutionContextInterface $context
     */
    public function isModifyValid(ExecutionContextInterface $context)
    {
        if ($this->getModify() && strtotime($this->getModify()) === false) {
            $context
                ->buildViolation('Wrong date/time format')
                ->atPath('modify')
                ->addViolation();
        }
    }

    /**
     * Update task after execution
     */
    public function executed()
    {
        $this->setLastRun(new \DateTime());
        if (!$this->getModify()) {
            $this->setStatus(self::STATUS_DISABLED);
        }
        if ($this->getStatus() == self::STATUS_ENABLED) {
            // find near time task launch
            $next_run = $this->getNextRun();
            do {
                // failed to compute time of next run
                if ($next_run->modify($this->getModify()) === false) {
                    $this->setModify('');
                    $this->setStatus(self::STATUS_DISABLED);
                    break;
                }
            } while ($next_run->getTimestamp() <= time());
            $this->setNextRun($next_run);
        }
    }
}