ExportBase::applyModifiers() - Code Metrics - Inspection of ":memo: API docs for the latest changes" - Heroyt/tournament-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5c3586...68bdab )

by Tomáš

created 2021-05-23 19:59 UTC

ExportBase::applyModifiers() A

↳ Parent: ExportBase

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php


namespace TournamentGenerator\Export;


use TournamentGenerator\HierarchyBase;

/**
 * Base class for exporters
 *
 * Exporters operate on some HierarchyBase class. They extract data and/or settings from these classes in a form of PHP array.
 * Exporters also allow of adding modifiers to the exported query - adding more data. These modifiers are added via specific methods (usually starting with "with" keyword).
 *
 * @package TournamentGenerator\Export
 * @author  Tomáš Vojík <[email protected]>
 * @since   0.5
 */
abstract class ExportBase implements Export
{

	/** @var HierarchyBase Hierarchy object to export */
	protected HierarchyBase $object;
	protected array         $modifiers = [];

	public function __construct(HierarchyBase $object) {
		$this->object = $object;
	}

	/**
	 * Finish the export query -> get the result
	 *
	 * @return array The query result
	 */
	public function get() : array {
		$data = $this->getBasic();
		$this->applyModifiers($data);
		return array_map(static function(object $object) {
			unset($object->object);
			return $object;
		}, $data);
	}

	/**
	 * Apply set modifiers to data array
	 *
	 * @param array $data
	 */
	protected function applyModifiers(array &$data) : void {
		foreach ($this->modifiers as $modifier) {
			$this->$modifier($data);
		}
	}
}

1		<?php
2
3
4		namespace TournamentGenerator\Export;
5
6
7		use TournamentGenerator\HierarchyBase;
8
9		/**
10		* Base class for exporters
11		*
12		* Exporters operate on some HierarchyBase class. They extract data and/or settings from these classes in a form of PHP array.
13		* Exporters also allow of adding modifiers to the exported query - adding more data. These modifiers are added via specific methods (usually starting with "with" keyword).
14		*
15		* @package TournamentGenerator\Export
16		* @author Tomáš Vojík <[email protected]>
17		* @since 0.5
18		*/
19		abstract class ExportBase implements Export
20		{
21
22		/** @var HierarchyBase Hierarchy object to export */
23		protected HierarchyBase $object;
24		protected array $modifiers = [];
25
26	12	public function __construct(HierarchyBase $object) {
27	12	$this->object = $object;
28	12	}
29
30		/**
31		* Finish the export query -> get the result
32		*
33		* @return array The query result
34		*/
35	11	public function get() : array {
36	11	$data = $this->getBasic();
37	11	$this->applyModifiers($data);
38	11	return array_map(static function(object $object) {
39	11	unset($object->object);
40	11	return $object;
41	11	}, $data);
42		}
43
44		/**
45		* Apply set modifiers to data array
46		*
47		* @param array $data
48		*/
49	11	protected function applyModifiers(array &$data) : void {
50	11	foreach ($this->modifiers as $modifier) {
51	5	$this->$modifier($data);
52		}
53		}
54		}

Heroyt / tournament-generator

Push — master ( 5c3586...68bdab )

ExportBase::applyModifiers() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like