Job::__sleep() - Code Metrics - A5hleyRich/wp-queue - Measure and Improve Code Quality continuously with Scrutinizer

Job::__sleep() A
last analyzed 2018-04-20 11:50 UTC

↳ Parent: Job

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	12
nc	2
nop	0
dl	0
loc	17
ccs	6
cts	6
cp	1
crap	2
rs	9.4285
c	0
b	0
f	0

<?php

namespace WP_Queue;

use Carbon\Carbon;
use Exception;

abstract class Job {

	/**
	 * @var int
	 */
	private $id;

	/**
	 * @var int
	 */
	private $attempts;

	/**
	 * @var Carbon
	 */
	private $reserved_at;

	/**
	 * @var Carbon
	 */
	private $available_at;

	/**
	 * @var Carbon
	 */
	private $created_at;

	/**
	 * @var bool
	 */
	private $released = false;

	/**
	 * @var bool
	 */
	private $failed = false;

	/**
	 * Handle job logic.
	 */
	abstract public function handle();

	/**
	 * Get job ID.
	 *
	 * @return int
	 */
	public function id() {
		return $this->id;
	}

	/**
	 * Set job ID.
	 *
	 * @param int $id
	 */
	public function set_id( $id ) {
		$this->id = $id;
	}

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

	/**
	 * Set job attempts.
	 *
	 * @param int $attempts
	 */
	public function set_attempts( $attempts ) {
		$this->attempts = $attempts;
	}

	/**
	 * Get reserved at date.
	 *
	 * @return Carbon
	 */
	public function reserved_at() {
		return $this->reserved_at;
	}

	/**
	 * Set reserved at date.
	 *
	 * @param null|Carbon $reserved_at
	 */
	public function set_reserved_at( $reserved_at ) {
		$this->reserved_at = $reserved_at;
	}

	/**
	 * Get available at date.
	 *
	 * @return Carbon
	 */
	public function available_at() {
		return $this->available_at;
	}

	/**
	 * Set available at date.
	 *
	 * @param Carbon $available_at
	 */
	public function set_available_at( Carbon $available_at ) {
		$this->available_at = $available_at;
	}

	/**
	 * Get created at date.
	 *
	 * @return Carbon
	 */
	public function created_at() {
		return $this->created_at;
	}

	/**
	 * Set created at date.
	 *
	 * @param Carbon $created_at
	 */
	public function set_created_at( Carbon $created_at ) {
		$this->created_at = $created_at;
	}

	/**
	 * Flag job as released.
	 */
	public function release() {
		$this->released = true;
		$this->attempts += 1;
	}

	/**
	 * Should the job be released back onto the queue?
	 *
	 * @return bool
	 */
	public function released() {
		return $this->released;
	}

	/**
	 * Flag job as failed.
	 */
	public function fail() {
		$this->failed = true;
	}

	/**
	 * Has the job failed?
	 *
	 * @return bool
	 */
	public function failed() {
		return $this->failed;
	}

	/**
	 * Determine which properties should be serialized.
	 *
	 * @return array
	 */
	public function __sleep() {
		$object_props   = get_object_vars( $this );
		$excluded_props = array(
			'id',
			'attempts',
			'reserved_at',
			'available_at',
			'created_at',
			'released',
			'failed',
		);

		foreach ( $excluded_props as $prop ) {
			unset( $object_props[ $prop ] );
		}

		return array_keys( $object_props );
	}

}

1		<?php
2
3		namespace WP_Queue;
4
5		use Carbon\Carbon;
6		use Exception;
7
8		abstract class Job {
9
10		/**
11		* @var int
12		*/
13		private $id;
14
15		/**
16		* @var int
17		*/
18		private $attempts;
19
20		/**
21		* @var Carbon
22		*/
23		private $reserved_at;
24
25		/**
26		* @var Carbon
27		*/
28		private $available_at;
29
30		/**
31		* @var Carbon
32		*/
33		private $created_at;
34
35		/**
36		* @var bool
37		*/
38		private $released = false;
39
40		/**
41		* @var bool
42		*/
43		private $failed = false;
44
45		/**
46		* Handle job logic.
47		*/
48		abstract public function handle();
49
50		/**
51		* Get job ID.
52		*
53		* @return int
54		*/
55	6	public function id() {
56	6	return $this->id;
57		}
58
59		/**
60		* Set job ID.
61		*
62		* @param int $id
63		*/
64	1	public function set_id( $id ) {
65	1	$this->id = $id;
66	1	}
67
68		/**
69		* Get job attempts;
70		*
71		* @return int
72		*/
73	3	public function attempts() {
74	3	return $this->attempts;
75		}
76
77		/**
78		* Set job attempts.
79		*
80		* @param int $attempts
81		*/
82	1	public function set_attempts( $attempts ) {
83	1	$this->attempts = $attempts;
84	1	}
85
86		/**
87		* Get reserved at date.
88		*
89		* @return Carbon
90		*/
91	1	public function reserved_at() {
92	1	return $this->reserved_at;
93		}
94
95		/**
96		* Set reserved at date.
97		*
98		* @param null\|Carbon $reserved_at
99		*/
100	1	public function set_reserved_at( $reserved_at ) {
101	1	$this->reserved_at = $reserved_at;
102	1	}
103
104		/**
105		* Get available at date.
106		*
107		* @return Carbon
108		*/
109	1	public function available_at() {
110	1	return $this->available_at;
111		}
112
113		/**
114		* Set available at date.
115		*
116		* @param Carbon $available_at
117		*/
118	1	public function set_available_at( Carbon $available_at ) {
119	1	$this->available_at = $available_at;
120	1	}
121
122		/**
123		* Get created at date.
124		*
125		* @return Carbon
126		*/
127	1	public function created_at() {
128	1	return $this->created_at;
129		}
130
131		/**
132		* Set created at date.
133		*
134		* @param Carbon $created_at
135		*/
136	1	public function set_created_at( Carbon $created_at ) {
137	1	$this->created_at = $created_at;
138	1	}
139
140		/**
141		* Flag job as released.
142		*/
143	1	public function release() {
144	1	$this->released = true;
145	1	$this->attempts += 1;
146	1	}
147
148		/**
149		* Should the job be released back onto the queue?
150		*
151		* @return bool
152		*/
153	1	public function released() {
154	1	return $this->released;
155		}
156
157		/**
158		* Flag job as failed.
159		*/
160	1	public function fail() {
161	1	$this->failed = true;
162	1	}
163
164		/**
165		* Has the job failed?
166		*
167		* @return bool
168		*/
169	1	public function failed() {
170	1	return $this->failed;
171		}
172
173		/**
174		* Determine which properties should be serialized.
175		*
176		* @return array
177		*/
178	7	public function __sleep() {
179	7	$object_props = get_object_vars( $this );
180		$excluded_props = array(
181	7	'id',
182		'attempts',
183		'reserved_at',
184		'available_at',
185		'created_at',
186		'released',
187		'failed',
188		);
189
190	7	foreach ( $excluded_props as $prop ) {
191	7	unset( $object_props[ $prop ] );
192		}
193
194	7	return array_keys( $object_props );
195		}
196
197		}

A5hleyRich / wp-queue

Job::__sleep() A last analyzed 2018-04-20 11:50 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Job::__sleep() A
last analyzed 2018-04-20 11:50 UTC