Charcoal\Queue\QueueableTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
	queue()	0	1	?
A	setQueueId()	0	17	3
A	queueId()	0	4	1

<?php

namespace Charcoal\Queue;

use InvalidArgumentException;

/**
 * Full implementation, as a Trait, of the `QueueableInterface`.
 */
trait QueueableTrait
{
    /**
     * The queue ID.
     *
     * @var mixed $queueId
     */
    private $queueId;

    /**
     * Set the queue's ID.
     *
     * @param string|null $id The unique queue identifier.
     * @throws InvalidArgumentException If the ID isn't a string.
     * @return self
     */
    public function setQueueId($id)
    {
        if ($id === null) {
            $this->queueId = null;
            return $this;
        }

        if (!is_string($id)) {
            throw new InvalidArgumentException(
                'Queue ID must be a string'
            );
        }

        $this->queueId = $id;

        return $this;
    }

    /**
     * Get the queue's ID.
     *
     * @return string|null $queueId
     */
    public function queueId()
    {
        return $this->queueId;
    }

    /**
     * Set the date/time to process the queue.
     *
     * @param mixed $ts A date/time to initiate the queue processing.
     * @return mixed
     */
    abstract public function queue($ts = null);
}