Job::process() - Code Metrics - Inspection of "Feature review for various features." - symbiote/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#290)

unknown

created 2020-04-30 00:23 UTC

Job::process() A

↳ Parent: Job

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	26
rs	9.504
c	0
b	0
f	0
cc	3
nc	3
nop	0

<?php

namespace App\Queue;

use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJob;

/**
 * Class Job
 *
 * This job represent a generic job which consumes items and each item is processed in one step
 * useful as a template for jobs which need to process multiple items
 * item can be an arbitrary piece of data for example: ID or array
 *
 * @property array $items
 * @property array $remaining
 * @package App\Queue
 */
abstract class Job extends AbstractQueuedJob
{

    public function getJobType(): int
    {
        return QueuedJob::QUEUED;
    }

    public function setup(): void
    {
        $this->remaining = $this->items;
        $this->totalSteps = count($this->items);
    }

    public function process(): void
    {
        $remaining = $this->remaining;

        // check for trivial case
        if (count($remaining) === 0) {
            $this->isComplete = true;

            return;
        }

        $item = array_shift($remaining);

        $this->processItem($item);

        // update job progress
        $this->remaining = $remaining;
        $this->currentStep += 1;

        // check for job completion
        if (count($remaining) > 0) {
            return;
        }

        $this->isComplete = true;
    }

    /**
     * @param mixed $item
     */
    abstract protected function processItem($item): void;
}


1			<?php
2
3			namespace App\Queue;
4
5			use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
6			use Symbiote\QueuedJobs\Services\QueuedJob;
7
8			/**
9			* Class Job
10			*
11			* This job represent a generic job which consumes items and each item is processed in one step
12			* useful as a template for jobs which need to process multiple items
13			* item can be an arbitrary piece of data for example: ID or array
14			*
15			* @property array $items
16			* @property array $remaining
17			* @package App\Queue
18			*/
19			abstract class Job extends AbstractQueuedJob
20			{
21
22			public function getJobType(): int
23			{
24			return QueuedJob::QUEUED;
25			}
26
27			public function setup(): void
28			{
29			$this->remaining = $this->items;
30			$this->totalSteps = count($this->items);
31			}
32
33			public function process(): void
34			{
35			$remaining = $this->remaining;
36
37			// check for trivial case
38			if (count($remaining) === 0) {
39			$this->isComplete = true;
40
41			return;
42			}
43
44			$item = array_shift($remaining);
45
46			$this->processItem($item);
47
48			// update job progress
49			$this->remaining = $remaining;
50			$this->currentStep += 1;
51
52			// check for job completion
53			if (count($remaining) > 0) {
54			return;
55			}
56
57			$this->isComplete = true;
58			}
59
60			/**
61			* @param mixed $item
62			*/
63			abstract protected function processItem($item): void;
64			}
65

symbiote / silverstripe-queuedjobs

GitHub Access Token became invalid

Pull Request — master (#290)

Job::process() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like