Disque\Queue\BaseJob

Complexity

Total Complexity

11

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	getBody()	0	4	1
A	setBody()	0	4	1
A	getId()	0	4	1
A	setId()	0	4	1
A	getQueue()	0	4	1
A	setQueue()	0	4	1
A	getNacks()	0	4	1
A	setNacks()	0	4	1
A	getAdditionalDeliveries()	0	4	1
A	setAdditionalDeliveries()	0	4	1

<?php
namespace Disque\Queue;

abstract class BaseJob implements JobInterface
{
    /**
     * Job ID
     *
     * @var string
     */
    protected $id;

    /**
     * Job body
     *
     * This is the job data. Whether just an integer, an array, that depends
     * on the use case.
     *
     * @var mixed
     */
    protected $body;

    /**
     * The name of the queue the job belongs to
     *
     * This is optional and can be null eg. when adding a new job.
     * It can however be used to identify what queue the job came from,
     * eg. in case of a consumer reading from multiple queues.
     *
     * @var string
     */
    protected $queue;

    /**
     * The number of NACKs this job has received
     *
     * NACK is a command which tells Disque that the job wasn't processed
     * successfully and it should return to the queue immediately.
     *
     * @var int
     */
    protected $nacks = 0;

    /**
     * The number of times this job has been re-delivered for reasons other
     * than a NACK
     *
     * @var int
     */
    protected $additionalDeliveries = 0;

    /**
     * An optional shortcut for instantiating the job with one call
     *
     * To make it more flexible, all arguments in the constructor are optional
     * and the job can be populated by calling the setters.
     *
     * @param mixed  $body Body            The job body
     * @param string $id                   The job ID
     * @param string $queue                Name of the queue the job belongs to
     * @param int    $nacks                The number of NACKs
     * @param int    $additionalDeliveries The number of additional deliveries
     */
    public function __construct(
        $body = null,
        $id = null,
        $queue = '',
        $nacks = 0,
        $additionalDeliveries = 0
    ) {
        $this->body = $body;
        $this->id = $id;
        $this->queue = $queue;
        $this->nacks = $nacks;
        $this->additionalDeliveries = $additionalDeliveries;
    }

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

    /**
     * @inheritdoc
     */
    public function setBody($body)
    {
        $this->body = $body;
    }

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

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

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

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

    /**
     * @inheritdoc
     */
    public function getNacks()
    {
        return $this->nacks;
    }

    /**
     * @inheritdoc
     */
    public function setNacks($nacks)
    {
        $this->nacks = $nacks;
    }

    /**
     * @inheritdoc
     */
    public function getAdditionalDeliveries()
    {
        return $this->additionalDeliveries;
    }

    /**
     * @inheritdoc
     */
    public function setAdditionalDeliveries($additionalDeliveries)
    {
        $this->additionalDeliveries = $additionalDeliveries;
    }
}