QueueableTrait::queueId() - Code Metrics - locomotivemtl/charcoal-queue - Measure and Improve Code Quality continuously with Scrutinizer

QueueableTrait::queueId() A
last analyzed 2020-09-16 18:24 UTC

↳ Parent: QueueableTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?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);
}


1			<?php
2
3			namespace Charcoal\Queue;
4
5			use InvalidArgumentException;
6
7			/**
8			* Full implementation, as a Trait, of the `QueueableInterface`.
9			*/
10			trait QueueableTrait
11			{
12			/**
13			* The queue ID.
14			*
15			* @var mixed $queueId
16			*/
17			private $queueId;
18
19			/**
20			* Set the queue's ID.
21			*
22			* @param string\|null $id The unique queue identifier.
23			* @throws InvalidArgumentException If the ID isn't a string.
24			* @return self
25			*/
26			public function setQueueId($id)
27			{
28			if ($id === null) {
29			$this->queueId = null;
30			return $this;
31			}
32
33			if (!is_string($id)) {
34			throw new InvalidArgumentException(
35			'Queue ID must be a string'
36			);
37			}
38
39			$this->queueId = $id;
40
41			return $this;
42			}
43
44			/**
45			* Get the queue's ID.
46			*
47			* @return string\|null $queueId
48			*/
49			public function queueId()
50			{
51			return $this->queueId;
52			}
53
54			/**
55			* Set the date/time to process the queue.
56			*
57			* @param mixed $ts A date/time to initiate the queue processing.
58			* @return mixed
59			*/
60			abstract public function queue($ts = null);
61			}
62

locomotivemtl / charcoal-queue

QueueableTrait::queueId() A last analyzed 2020-09-16 18:24 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

QueueableTrait::queueId() A
last analyzed 2020-09-16 18:24 UTC