Taskwarrior/src/Task.php

<?php

namespace DavidBadura\Taskwarrior;

use JMS\Serializer\Annotation as JMS;

/**
 * @author David Badura <d.a.badura@gmail.com>
 */
class Task
{
    const STATUS_PENDING   = 'pending';
    const STATUS_COMPLETED = 'completed';
    const STATUS_DELETED   = 'deleted';
    const STATUS_WAITING   = 'waiting';

    const PRIORITY_LOW    = 'L';
    const PRIORITY_MEDIUM = 'M';
    const PRIORITY_HIGH   = 'H';

    /**
     * @var string
     *
     * @JMS\Type(name="string")
     */
    private $uuid;

    /**
     * @var string
     *
     * @JMS\Type(name="string")
     */
    private $description;

    /**
     * @var string
     *
     * @JMS\Type(name="string")
     */
    private $priority;

    /**
     * @var string
     *
     * @JMS\Type(name="string")
     */
    private $project;

    /**
     * @var \DateTime
     *
     * @JMS\Type(name="DateTime<'Ymd\THis\Z'>")
     */
    private $due;

    /**
     * @var \DateTime
     *
     * @JMS\Type(name="DateTime<'Ymd\THis\Z'>")
     */
    private $wait;

    /**
     * @var \DateTime
     *
     * @JMS\Type(name="DateTime<'Ymd\THis\Z'>")
     */
    private $until;

    /**
     * @var array
     *
     * @JMS\Type(name="array<string>")
     */
    private $tags;

    /**
     * @var float
     *
     * @JMS\Type(name="float")
     */
    private $urgency;

    /**
     * @var \DateTime
     *
     * @JMS\Type(name="DateTime<'Ymd\THis\Z'>")
     */
    private $entry;


    /**
     * @var \DateTime
     *
     * @JMS\Type(name="DateTime<'Ymd\THis\Z'>")
     */
    private $modified;

    /**
     * @var \DateTime
     *
     * @JMS\Type(name="DateTime<'Ymd\THis\Z'>")
     */
    private $end;

    /**
     * @var string
     *
     * @JMS\Type(name="string")
     */
    private $status;

    /**
     *
     */
    public function __construct()
    {
        $this->urgency = 0;
        $this->entry   = new \DateTime('now', new \DateTimeZone('UTC'));
        $this->status  = self::STATUS_PENDING;
    }

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

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

    /**
     * @param string $description
     */
    public function setDescription($description)
    {
        $this->description = $description;
    }

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

    /**
     * @param string $priority
     */
    public function setPriority($priority)
    {
        $this->priority = $priority;
    }

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

    /**
     * @param string $project
     */
    public function setProject($project)
    {
        $this->project = $project;
    }

    /**
     * @return \DateTime
     */
    public function getDue()
    {
        return $this->due;
    }

    /**
     * @param \DateTime|string $due
     */
    public function setDue($due = null)
    {
        $this->due = $this->parseDateTime($due);
    }

    /**
     * @return \DateTime
     */
    public function getWait()
    {
        return $this->wait;
    }

    /**
     * @param \DateTime|string $wait
     */
    public function setWait($wait = null)
    {
        $this->wait = $this->parseDateTime($wait);
    }

    /**
     * @return \DateTime
     */
    public function getUntil()
    {
        return $this->until;
    }

    /**
     * @param \DateTime|string $until
     */
    public function setUntil($until = null)
    {
        $this->until = $this->parseDateTime($until);
    }

    /**
     * @return array
     */
    public function getTags()
    {
        return (array)$this->tags;
    }

    /**
     * @param array $tags
     */
    public function setTags(array $tags = array())
    {
        $this->tags = $tags;
    }

    /**
     * @param string $tag
     */
    public function addTag($tag)
    {
        if (!$this->tags) {
            $this->tags = [$tag];
        }

        if (!in_array($tag, $this->tags)) {
            $this->tags[] = $tag;
        }
    }

    /**
     * @param string $tag
     */
    public function removeTag($tag)
    {
        if (!$this->tags) {
            return;
        }

        if (false !== $key = array_search($tag, $this->tags)) {
            unset($this->tags[$key]);
        }
    }

    /**
     * @return \DateTime
     */
    public function getEntry()
    {
        return $this->entry;
    }

    /**
     * @return \DateTime
     */
    public function getModified()
    {
        return $this->modified;
    }

    /**
     * @return \DateTime
     */
    public function getEnd()
    {
        return $this->end;
    }

    /**
     * @return float
     */
    public function getUrgency()
    {
        return $this->urgency;
    }

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

    /**
     * @return bool
     */
    public function isPending()
    {
        return $this->status == self::STATUS_PENDING;
    }

    /**
     * @return bool
     */
    public function isCompleted()
    {
        return $this->status == self::STATUS_COMPLETED;
    }

    /**
     * @return bool
     */
    public function isWaiting()
    {
        return $this->status == self::STATUS_WAITING;
    }

    /**
     * @return bool
     */
    public function isDeleted()
    {
        return $this->status == self::STATUS_DELETED;
    }

    /**
     * @param string|\DateTime|null $date
     * @return \DateTime|null
     * @throws TaskwarriorException
     */
    private function parseDateTime($date)
    {
        if ($date instanceof \DateTime) {

            $date = clone $date;
            $date->setTimezone(new \DateTimeZone('UTC'));

            return $date;
        }

        if (is_string($date)) {
            return new \DateTime($date, new \DateTimeZone('UTC'));
        }

        if ($date === null) {
            return null;
        }

        throw new TaskwarriorException();
    }

    /**
     *
     */
    public function __clone()
    {
        $this->uuid   = null;
        $this->entry  = new \DateTime('now', new \DateTimeZone('UTC'));
        $this->status = self::STATUS_PENDING;
    }
}