Workana\AsyncJobs\Job

Complexity

Total Complexity

13

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	6	1
A	getDelay()	0	4	1
A	withDelay()	0	4	1
A	incrementRetries()	0	10	2
A	getRetries()	0	4	1
A	areRetriesExhausted()	0	4	1
A	getMaxRetries()	0	4	1
A	withMaxRetries()	0	4	1
A	getPreferredQueueName()	0	4	1
A	hasPreferredQueue()	0	4	1
A	withPreferredQueueName()	0	4	2

<?php
namespace Workana\AsyncJobs;

use InvalidArgumentException;
use Bernard\Message;

/**
 * Abstract job
 *
 * @author Carlos Frutos <charly@workana.com>
 */
abstract class Job implements Message 
{
    const DEFAULT_MAX_RETRIES = 10;

    /**
     * @var int
     */
    protected $delay = 0;

    /**
     * @var int
     */
    protected $retries = 0;

    /**
     * @var int
     */
    protected $maxRetries = self::DEFAULT_MAX_RETRIES;

    /**
     * @var string?
     */
    protected $preferredQueueName;

    /**
     * {@inheritdoc}
     */
    public final function getName()

As per PSR2, final should precede the visibility keyword.

    {
        $class = get_class($this);

        return current(array_reverse(explode('\\', $class)));
    }

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

    /**
     * With delay (in seconds)
     *
     * @param int $delay Delay
     *
     * @return void
     */
    public function withDelay($delay = 0)
    {
        $this->delay = (int) $delay;
    }

    /**
     * Increment retries, step one
     *
     * @return void
     */
    public function incrementRetries()
    {
        $nextRetry = $this->retries + 1;

        if ($nextRetry > $this->maxRetries) {
            throw new InvalidArgumentException('Max retries exceeded');
        }

        $this->retries = $nextRetry;
    }

    /**
     * Total retries
     *
     * @return int
     */
    public function getRetries()
    {
        return $this->retries;
    }

    /**
     * Are retries exhausted?
     *
     * @return bool
     */
    public function areRetriesExhausted()
    {
        return ($this->retries === $this->maxRetries);
    }

    /**
     * Max retries
     *
     * @return int
     */
    public function getMaxRetries()
    {
        return $this->maxRetries;
    }

    /**
     * @param int $maxRetries
     *
     * @return int
     */
    public function withMaxRetries($maxRetries)
    {
        $this->maxRetries = (int) $maxRetries;
    }

    public function getPreferredQueueName()
    {
        return $this->preferredQueueName;
    }

    public function hasPreferredQueue()
    {
        return !empty($this->preferredQueueName);
    }

    public function withPreferredQueueName($preferredQueueName)
    {
        $this->preferredQueueName = $preferredQueueName ?(string) $preferredQueueName : null;
    }
}