OrderItem::__construct() - Code Metrics - Inspection of "Merge branch 'release/2.1.9'" - wp-pay-gateways/omnikassa-2 - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( f8b3b2...e22298 )

by Remco

created 2019-10-04 13:23 UTC

OrderItem::__construct() A

↳ Parent: OrderItem

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	4
c	1
b	0
f	0
nc	1
nop	4
dl	0
loc	5
ccs	5
cts	5
cp	1
crap	1
rs	10

<?php
/**
 * Order item.
 *
 * @author    Pronamic <[email protected]>
 * @copyright 2005-2019 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Pay\Gateways\OmniKassa2
 */

namespace Pronamic\WordPress\Pay\Gateways\OmniKassa2;

/**
 * Order item.
 *
 * @author  Reüel van der Steege
 * @version 2.1.8
 * @since   2.0.3
 */
class OrderItem {
	/**
	 * Item id.
	 *
	 * @var string|null
	 */
	private $id;

	/**
	 * Item name (required).
	 *
	 * @var string
	 */
	private $name;

	/**
	 * Description.
	 *
	 * @var string|null
	 */
	private $description;

	/**
	 * Quantity (required).
	 *
	 * @var int
	 */
	private $quantity;

	/**
	 * Amount (required).
	 *
	 * @var Money
	 */
	private $amount;

	/**
	 * Tax.
	 *
	 * @var Money|null
	 */
	private $tax;

	/**
	 * Category; physical or digital (required).
	 *
	 * @var string
	 */
	private $category;

	/**
	 * VAT category.
	 *
	 * @var string|null
	 */
	private $vat_category;

	/**
	 * Construct order result.
	 *
	 * @param string $name     Name.
	 * @param int    $quantity Quantity.
	 * @param Money  $amount   Amount.
	 * @param string $category Category.
	 * @throws \InvalidArgumentException Throws invalid argument exception when arguments are invalid.
	 */
	public function __construct( $name, $quantity, Money $amount, $category ) {
		$this->set_name( $name );
		$this->quantity = $quantity;
		$this->amount   = $amount;
		$this->set_category( $category );
	}

	/**
	 * Get item ID.
	 *
	 * @return string|null
	 */
	public function get_id() {
		return $this->id;
	}

	/**
	 * Set item ID.
	 *
	 * @param string|null $id ID.
	 */
	public function set_id( $id = null ) {
		$this->id = $id;
	}

	/**
	 * Get item name.
	 *
	 * @return string
	 */
	public function get_name() {
		return $this->name;
	}

	/**
	 * Set item name.
	 *
	 * @param string $name Name.
	 * @throws \InvalidArgumentException Throws invalid argument exception when value does not apply to format `AN..max 50`.
	 */
	public function set_name( $name ) {
		DataHelper::validate_an( $name, 50, 'OrderItems.name' );

		$this->name = $name;
	}

	/**
	 * Get item description.
	 *
	 * @return string|null
	 */
	public function get_description() {
		return $this->description;
	}

	/**
	 * Set item description.
	 *
	 * @param string|null $description Description.
	 * @throws \InvalidArgumentException Throws invalid argument exception when value does not apply to format `AN..max 100`.
	 */
	public function set_description( $description ) {
		DataHelper::validate_null_or_an( $description, 100, 'OrderItems.description' );

		$this->description = $description;
	}

	/**
	 * Get quantity.
	 *
	 * @return int
	 */
	public function get_quantity() {
		return $this->quantity;
	}

	/**
	 * Get amount.
	 *
	 * @return Money
	 */
	public function get_amount() {
		return $this->amount;
	}

	/**
	 * Get tax.
	 *
	 * @return Money|null
	 */
	public function get_tax() {
		return $this->tax;
	}

	/**
	 * Set tax.
	 *
	 * @param Money|null $tax Tax.
	 */
	public function set_tax( Money $tax = null ) {
		$this->tax = $tax;
	}

	/**
	 * Get category.
	 *
	 * @return string
	 */
	public function get_category() {
		return $this->category;
	}

	/**
	 * Set category.
	 *
	 * @param string $category Product category: PHYSICAL or DIGITAL.
	 * @throws \InvalidArgumentException Throws invalid argument exception when value does not apply to format `AN..max 8`.
	 */
	public function set_category( $category ) {
		DataHelper::validate_an( $category, 8, 'OrderItems.category' );

		$this->category = $category;
	}

	/**
	 * Get VAT category.
	 *
	 * @return string|null
	 */
	public function get_vat_category() {
		return $this->vat_category;
	}

	/**
	 * Set VAT category.
	 *
	 * @param string|null $vat_category VAT category.
	 */
	public function set_vat_category( $vat_category ) {
		$this->vat_category = $vat_category;
	}

	/**
	 * Get JSON.
	 *
	 * @return object
	 */
	public function get_json() {
		$object = (object) array();

		if ( null !== $this->id ) {
			$object->id = $this->id;
		}

		$object->name = $this->name;

		if ( null !== $this->description ) {
			$object->description = $this->description;
		}

		$object->quantity = $this->quantity;
		$object->amount   = $this->amount->get_json();

		if ( null !== $this->tax ) {
			$object->tax = $this->tax->get_json();
		}

		$object->category = $this->category;

		if ( null !== $this->vat_category ) {
			$object->vatCategory = $this->vat_category;
		}

		return $object;
	}

	/**
	 * Get signature fields.
	 *
	 * @param array<string> $fields Fields.
	 * @return array<string>
	 */
	public function get_signature_fields( $fields = array() ) {
		if ( null !== $this->id ) {
			$fields[] = $this->id;
		}

		$fields[] = $this->name;
		$fields[] = $this->description;
		$fields[] = \strval( $this->quantity );

		$fields = $this->amount->get_signature_fields( $fields );

		if ( null === $this->tax ) {
			$fields[] = '';
		} else {
			$fields = $this->tax->get_signature_fields( $fields );
		}

		$fields[] = $this->category;

		if ( null !== $this->vat_category ) {
			$fields[] = $this->vat_category;
		}

		return $fields;
	}
}


1		<?php
2		/**
3		* Order item.
4		*
5		* @author Pronamic <[email protected]>
6		* @copyright 2005-2019 Pronamic
7		* @license GPL-3.0-or-later
8		* @package Pronamic\WordPress\Pay\Gateways\OmniKassa2
9		*/
10
11		namespace Pronamic\WordPress\Pay\Gateways\OmniKassa2;
12
13		/**
14		* Order item.
15		*
16		* @author Reüel van der Steege
17		* @version 2.1.8
18		* @since 2.0.3
19		*/
20		class OrderItem {
21		/**
22		* Item id.
23		*
24		* @var string\|null
25		*/
26		private $id;
27
28		/**
29		* Item name (required).
30		*
31		* @var string
32		*/
33		private $name;
34
35		/**
36		* Description.
37		*
38		* @var string\|null
39		*/
40		private $description;
41
42		/**
43		* Quantity (required).
44		*
45		* @var int
46		*/
47		private $quantity;
48
49		/**
50		* Amount (required).
51		*
52		* @var Money
53		*/
54		private $amount;
55
56		/**
57		* Tax.
58		*
59		* @var Money\|null
60		*/
61		private $tax;
62
63		/**
64		* Category; physical or digital (required).
65		*
66		* @var string
67		*/
68		private $category;
69
70		/**
71		* VAT category.
72		*
73		* @var string\|null
74		*/
75		private $vat_category;
76
77		/**
78		* Construct order result.
79		*
80		* @param string $name Name.
81		* @param int $quantity Quantity.
82		* @param Money $amount Amount.
83		* @param string $category Category.
84		* @throws \InvalidArgumentException Throws invalid argument exception when arguments are invalid.
85		*/
86	2	public function __construct( $name, $quantity, Money $amount, $category ) {
87	2	$this->set_name( $name );
88	2	$this->quantity = $quantity;
89	2	$this->amount = $amount;
90	2	$this->set_category( $category );
91	2	}
92
93		/**
94		* Get item ID.
95		*
96		* @return string\|null
97		*/
98		public function get_id() {
99		return $this->id;
100		}
101
102		/**
103		* Set item ID.
104		*
105		* @param string\|null $id ID.
106		*/
107	1	public function set_id( $id = null ) {
108	1	$this->id = $id;
109	1	}
110
111		/**
112		* Get item name.
113		*
114		* @return string
115		*/
116	1	public function get_name() {
117	1	return $this->name;
118		}
119
120		/**
121		* Set item name.
122		*
123		* @param string $name Name.
124		* @throws \InvalidArgumentException Throws invalid argument exception when value does not apply to format `AN..max 50`.
125		*/
126	2	public function set_name( $name ) {
127	2	DataHelper::validate_an( $name, 50, 'OrderItems.name' );
128
129	2	$this->name = $name;
130	2	}
131
132		/**
133		* Get item description.
134		*
135		* @return string\|null
136		*/
137		public function get_description() {
138		return $this->description;
139		}
140
141		/**
142		* Set item description.
143		*
144		* @param string\|null $description Description.
145		* @throws \InvalidArgumentException Throws invalid argument exception when value does not apply to format `AN..max 100`.
146		*/
147	1	public function set_description( $description ) {
148	1	DataHelper::validate_null_or_an( $description, 100, 'OrderItems.description' );
149
150	1	$this->description = $description;
151	1	}
152
153		/**
154		* Get quantity.
155		*
156		* @return int
157		*/
158		public function get_quantity() {
159		return $this->quantity;
160		}
161
162		/**
163		* Get amount.
164		*
165		* @return Money
166		*/
167		public function get_amount() {
168		return $this->amount;
169		}
170
171		/**
172		* Get tax.
173		*
174		* @return Money\|null
175		*/
176		public function get_tax() {
177		return $this->tax;
178		}
179
180		/**
181		* Set tax.
182		*
183		* @param Money\|null $tax Tax.
184		*/
185	1	public function set_tax( Money $tax = null ) {
186	1	$this->tax = $tax;
187	1	}
188
189		/**
190		* Get category.
191		*
192		* @return string
193		*/
194		public function get_category() {
195		return $this->category;
196		}
197
198		/**
199		* Set category.
200		*
201		* @param string $category Product category: PHYSICAL or DIGITAL.
202		* @throws \InvalidArgumentException Throws invalid argument exception when value does not apply to format `AN..max 8`.
203		*/
204	2	public function set_category( $category ) {
205	2	DataHelper::validate_an( $category, 8, 'OrderItems.category' );
206
207	2	$this->category = $category;
208	2	}
209
210		/**
211		* Get VAT category.
212		*
213		* @return string\|null
214		*/
215		public function get_vat_category() {
216		return $this->vat_category;
217		}
218
219		/**
220		* Set VAT category.
221		*
222		* @param string\|null $vat_category VAT category.
223		*/
224	1	public function set_vat_category( $vat_category ) {
225	1	$this->vat_category = $vat_category;
226	1	}
227
228		/**
229		* Get JSON.
230		*
231		* @return object
232		*/
233		public function get_json() {
234		$object = (object) array();
235
236		if ( null !== $this->id ) {
237		$object->id = $this->id;
238		}
239
240		$object->name = $this->name;
241
242		if ( null !== $this->description ) {
243		$object->description = $this->description;
244		}
245
246		$object->quantity = $this->quantity;
247		$object->amount = $this->amount->get_json();
248
249		if ( null !== $this->tax ) {
250		$object->tax = $this->tax->get_json();
251		}
252
253		$object->category = $this->category;
254
255		if ( null !== $this->vat_category ) {
256		$object->vatCategory = $this->vat_category;
257		}
258
259		return $object;
260		}
261
262		/**
263		* Get signature fields.
264		*
265		* @param array<string> $fields Fields.
266		* @return array<string>
267		*/
268	1	public function get_signature_fields( $fields = array() ) {
269	1	if ( null !== $this->id ) {
270	1	$fields[] = $this->id;
271		}
272
273	1	$fields[] = $this->name;
274	1	$fields[] = $this->description;
275	1	$fields[] = \strval( $this->quantity );
276
277	1	$fields = $this->amount->get_signature_fields( $fields );
278
279	1	if ( null === $this->tax ) {
280		$fields[] = '';
281		} else {
282	1	$fields = $this->tax->get_signature_fields( $fields );
283		}
284
285	1	$fields[] = $this->category;
286
287	1	if ( null !== $this->vat_category ) {
288	1	$fields[] = $this->vat_category;
289		}
290
291	1	return $fields;
292		}
293		}
294

wp-pay-gateways / omnikassa-2

Push — master ( f8b3b2...e22298 )

OrderItem::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like