Phloppy\Job

Complexity

Total Complexity

20

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	1	Features	2

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getId()	0	4	1
A	setId()	0	4	1
A	getBody()	0	4	1
A	getDelay()	0	4	1
A	setDelay()	0	4	1
A	getRetry()	0	4	1
A	setRetry()	0	4	1
A	getTtL()	0	4	1
A	setTtl()	0	4	1
A	getQueue()	0	4	1
A	setQueue()	0	4	1
B	create()	0	23	5
A	getOriginNode()	0	4	2
A	__toString()	0	4	1

<?php
namespace Phloppy;

class Job {

    const STATE_ACTIVE       = 'active';
    const STATE_WAIT_REPL    = 'wait-repl';
    const STATE_QUEUED       = 'queued';
    const STATE_ACKNOWLEDGED = 'acknowledged';

    /**
     * Job Id (generated by disque).
     *
     * @var string
     */
    private $id = '';


    /**
     * Queue name this job was fetched from.
     *
     * @var string
     */
    private $queue = '';


    /**
     * Job body.
     *
     * @var string
     */
    private $body = '';


    /**
     * Delay time (before putting the job into the queue, in seconds).
     *
     * @var int
     */
    private $delay = 0;


    /**
     * Retry time (seconds).
     *
     * How much time should elapse, since the last time the job was queued, and without an acknowledge about the job
     * delivery, before the job is re-queued again for delivery.
     *
     * @var int
     */
    private $retry = 120;


    /**
     * The expire time (in seconds).
     *
     * How much time should elapse for the job to be deleted regardless of the fact it was successfully delivered,
     * i.e. acknowledged, or not.
     *
     * @var int
     */
    private $ttl = 3600;


    public function __construct($body)
    {
        $this->body = $body;
    }


    /**
     * Return the job id.
     *
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

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

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

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

    /**
     * @param int $delay
     */
    public function setDelay($delay)
    {
        $this->delay = (int) $delay;
    }

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

    /**
     * @param int $retry
     */
    public function setRetry($retry)
    {
        $this->retry = $retry;
    }

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

    /**
     * @param mixed $ttl
     */
    public function setTtl($ttl)
    {
        $this->ttl = $ttl;
    }

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

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


    /**
     * Job Factory method.
     *
     * @param array $args
     * @return Job
     */
    public static function create(array $args)
    {
        $job = new Job($args['body']);

        if (isset($args['id'])) {
            $job->setId($args['id']);
            $job->setTtl(hexdec(substr($job->getId(), -4)));
        }

        if (isset($args['queue'])) {
            $job->setQueue($args['queue']);
        }

        if (isset($args['ttl'])) {
            $job->setTtl($args['ttl']);
        }

        if (isset($args['retry'])) {
            $job->setRetry($args['retry']);
        }

        return $job;
    }

    /**
     * Retrieve the originating node id.
     *
     * @return string|null The node id of the node where the job was published
     */
    public function getOriginNode()
    {
        return $this->id ? substr($this->id, 2, 8) : null;
    }

    public function __toString()
    {
        return $this->getId();
    }
}