Team::getSeed() - Code Metrics - Inspection of ":white_check_mark: Added mutation tests" - Heroyt/tournament-generator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 228718...2540c1 )

by Tomáš

created 2021-07-11 21:57 UTC

Team::getSeed() A

↳ Parent: Team

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace TournamentGenerator;

use Exception;
use InvalidArgumentException;
use TournamentGenerator\Export\ExporterInterface;
use TournamentGenerator\Export\Single\TeamExporter;
use TournamentGenerator\Interfaces\Exportable;
use TournamentGenerator\Traits\HasPositions;
use TournamentGenerator\Traits\HasScore;

/**
 * Class that identifies a team and holds the scores from the whole tournament.
 *
 * @author  Tomáš Vojík <[email protected]>
 *
 * @since   0.1
 * @package TournamentGenerator
 */
class Team extends Base implements Exportable
{
	use HasScore;
	use HasPositions;

	/**
	 * @var string     $name The name of the team
	 * @var string|int $id   The unique identifier of the team
	 */

	/** @var Game[] $games A list of games played by this team */
	protected array $games = [];
	/** @var array $gamesWith Multi-dimensional associative array of number of games together with other teams */
	protected array $gamesWith = [];
	/** @var int Seeding score */
	protected int $seed = 0;

	/**
	 * Initiates a team class
	 *
	 * @param string     $name Name of the team
	 * @param string|int $id   Unique identifier of the team
	 *
	 * @throws InvalidArgumentException if the provided argument id is not of type 'null' or 'string' or 'int'
	 */
	public function __construct(string $name = 'team', $id = null) {
		$this->setName($name);
		$this->setId($id ?? uniqid('', false));
	}

	public function seed(int $score) : Team {
		$this->seed = $score;
		return $this;
	}

	/**
	 * Gets team statistics from the given group without the group object
	 *
	 * @param string|int $groupId Unique identifier of the group to get its results
	 *
	 * @return array  All the statistics including points, score, wins, draws, losses, times being second, times being third
	 * @throws Exception if the group with given groupId doesn't exist
	 *
	 */
	public function getGamesInfo($groupId) : array {
		return array_filter($this->getGroupResults($groupId), static function($k) {
			return $k !== 'group';
		}, ARRAY_FILTER_USE_KEY);
	}

	/**
	 * Gets team statistics from the given group
	 *
	 * @param string|int|null $groupId Unique identifier of the group to get its results
	 *
	 * @return array  All the statistics including points, score, wins, draws, losses, times being second, times being third if the group id is set or all the statistics
	 * @throws Exception if the group with given groupId doesn't exist
	 *
	 */
	public function getGroupResults($groupId = null) : array {
		if (isset($groupId)) {
			if (!isset($this->groupResults[$groupId])) {
				throw new Exception('Trying to get nonexistent group results ('.$groupId.')');
			}
			return $this->groupResults[$groupId];
		}
		return $this->groupResults;
	}

	/**
	 * Creates a new data-array to store statistics for a new group
	 *
	 * Resets the statistics if the group was already added
	 *
	 * @param Group $group A group object to add its results
	 *
	 * @return $this
	 */
	public function addGroupResults(Group $group) : Team {
		$this->groupResults[$group->getId()] = [
			'group'  => $group,
			'points' => 0,
			'score'  => 0,
			'wins'   => 0,
			'draws'  => 0,
			'losses' => 0,
			'second' => 0,
			'third'  => 0
		];
		return $this;
	}

	/**
	 * Adds a record of a game with another team in a group
	 *
	 * @param Team  $team  A team that played with this team
	 * @param Group $group A group that the teams were playing in
	 *
	 * @return $this
	 */
	public function addGameWith(Team $team, Group $group) : Team {
		if (!isset($this->gamesWith[$group->getId()][$team->getId()])) {
			$this->gamesWith[$group->getId()][$team->getId()] = 0;
		}
		$this->gamesWith[$group->getId()][$team->getId()]++;
		return $this;
	}

	/**
	 * Gets a record of a game with another team or teams
	 *
	 * @param Team|null  $team  A team to get the games with
	 * @param Group|null $group A group from where to get the games
	 *
	 * @return array|int The number of games played with a team in a group if both arguments are given, array of all games with all teams from a group if only group is given, array of games with team from all groups if only a team argument is given or all games with all teams from all groups if no argument is given
	 */
	public function getGameWith(Team $team = null, Group $group = null) {
		if (isset($group)) {
			if (isset($team)) {
				return $this->gamesWith[$group->getId()][$team->getId()];
			}
			return $this->gamesWith[$group->getId()];
		}
		if (isset($team)) {
			$return = [];
			foreach ($this->gamesWith as $id => $games) {
				$filter = array_filter($games, static function($key) use ($team) {
					return $key === $team->getId();
				}, ARRAY_FILTER_USE_KEY);
				if (count($filter) > 0) {
					$return[$id] = $filter;
				}
			}
			return $return;
		}
		return $this->gamesWith;
	}

	/**
	 * Adds a group to a team and creates an array for all games to be played
	 *
	 * @param Group $group A group to add
	 *
	 * @return $this
	 */
	public function addGroup(Group $group) : Team {
		if (!isset($this->games[$group->getId()])) {
			$this->games[$group->getId()] = [];
		}
		return $this;
	}

	/**
	 * Adds a game to this team
	 *
	 * @param Game $game A game to add
	 *
	 * @return $this
	 */
	public function addGame(Game $game) : Team {
		$group = $game->getGroup();
		if (!isset($this->games[$group->getId()])) {
			$this->games[$group->getId()] = [];
		}
		$this->games[$group->getId()][] = $game;
		return $this;
	}

	/**
	 * Gets all game from given group
	 *
	 * @param Group|null      $group   A group to get its game from
	 * @param string|int|null $groupId An id of group to get its game from
	 *
	 * @return array Games from a group or all games if both arguments are null
	 */
	public function getGames(?Group $group = null, $groupId = null) {
		if (!is_null($group) && isset($this->games[$group->getId()])) {
			return $this->games[$group->getId()];
		}
		if (isset($groupId, $this->games[$groupId])) {
			return $this->games[$groupId];
		}
		return $this->games;
	}

	/**
	 * Prepares an export query for the object
	 *
	 * @return ExporterInterface Exporter for this class
	 */
	public function export() : ExporterInterface {
		return TeamExporter::start($this);
	}

	/**
	 * Get seeding score
	 *
	 * @return int
	 */
	public function getSeed() : int {
		return $this->seed;
	}
}


1		<?php
2
3		namespace TournamentGenerator;
4
5		use Exception;
6		use InvalidArgumentException;
7		use TournamentGenerator\Export\ExporterInterface;
8		use TournamentGenerator\Export\Single\TeamExporter;
9		use TournamentGenerator\Interfaces\Exportable;
10		use TournamentGenerator\Traits\HasPositions;
11		use TournamentGenerator\Traits\HasScore;
12
13		/**
14		* Class that identifies a team and holds the scores from the whole tournament.
15		*
16		* @author Tomáš Vojík <[email protected]>
17		*
18		* @since 0.1
19		* @package TournamentGenerator
20		*/
21		class Team extends Base implements Exportable
22		{
23		use HasScore;
24		use HasPositions;
25
26		/**
27		* @var string $name The name of the team
28		* @var string\|int $id The unique identifier of the team
29		*/
30
31		/** @var Game[] $games A list of games played by this team */
32		protected array $games = [];
33		/** @var array $gamesWith Multi-dimensional associative array of number of games together with other teams */
34		protected array $gamesWith = [];
35		/** @var int Seeding score */
36		protected int $seed = 0;
37
38		/**
39		* Initiates a team class
40		*
41		* @param string $name Name of the team
42		* @param string\|int $id Unique identifier of the team
43		*
44		* @throws InvalidArgumentException if the provided argument id is not of type 'null' or 'string' or 'int'
45		*/
46	265	public function __construct(string $name = 'team', $id = null) {
47	265	$this->setName($name);
48	265	$this->setId($id ?? uniqid('', false));
49	265	}
50
51	1	public function seed(int $score) : Team {
52	1	$this->seed = $score;
53	1	return $this;
54		}
55
56		/**
57		* Gets team statistics from the given group without the group object
58		*
59		* @param string\|int $groupId Unique identifier of the group to get its results
60		*
61		* @return array All the statistics including points, score, wins, draws, losses, times being second, times being third
62		* @throws Exception if the group with given groupId doesn't exist
63		*
64		*/
65	3	public function getGamesInfo($groupId) : array {
66	3	return array_filter($this->getGroupResults($groupId), static function($k) {
67	3	return $k !== 'group';
68	3	}, ARRAY_FILTER_USE_KEY);
69		}
70
71		/**
72		* Gets team statistics from the given group
73		*
74		* @param string\|int\|null $groupId Unique identifier of the group to get its results
75		*
76		* @return array All the statistics including points, score, wins, draws, losses, times being second, times being third if the group id is set or all the statistics
77		* @throws Exception if the group with given groupId doesn't exist
78		*
79		*/
80	23	public function getGroupResults($groupId = null) : array {
81	23	if (isset($groupId)) {
82	8	if (!isset($this->groupResults[$groupId])) {
83	1	throw new Exception('Trying to get nonexistent group results ('.$groupId.')');
84		}
85	7	return $this->groupResults[$groupId];
86		}
87	17	return $this->groupResults;
88		}
89
90		/**
91		* Creates a new data-array to store statistics for a new group
92		*
93		* Resets the statistics if the group was already added
94		*
95		* @param Group $group A group object to add its results
96		*
97		* @return $this
98		*/
99	218	public function addGroupResults(Group $group) : Team {
100	218	$this->groupResults[$group->getId()] = [
101	218	'group' => $group,
102	218	'points' => 0,
103	218	'score' => 0,
104	218	'wins' => 0,
105	218	'draws' => 0,
106	218	'losses' => 0,
107	218	'second' => 0,
108	218	'third' => 0
109		];
110	218	return $this;
111		}
112
113		/**
114		* Adds a record of a game with another team in a group
115		*
116		* @param Team $team A team that played with this team
117		* @param Group $group A group that the teams were playing in
118		*
119		* @return $this
120		*/
121	206	public function addGameWith(Team $team, Group $group) : Team {
122	206	if (!isset($this->gamesWith[$group->getId()][$team->getId()])) {
123	206	$this->gamesWith[$group->getId()][$team->getId()] = 0;
124		}
125	206	$this->gamesWith[$group->getId()][$team->getId()]++;
126	206	return $this;
127		}
128
129		/**
130		* Gets a record of a game with another team or teams
131		*
132		* @param Team\|null $team A team to get the games with
133		* @param Group\|null $group A group from where to get the games
134		*
135		* @return array\|int The number of games played with a team in a group if both arguments are given, array of all games with all teams from a group if only group is given, array of games with team from all groups if only a team argument is given or all games with all teams from all groups if no argument is given
136		*/
137	3	public function getGameWith(Team $team = null, Group $group = null) {
138	3	if (isset($group)) {
139	3	if (isset($team)) {
140	3	return $this->gamesWith[$group->getId()][$team->getId()];
141		}
142	3	return $this->gamesWith[$group->getId()];
143		}
144	2	if (isset($team)) {
145	1	$return = [];
146	1	foreach ($this->gamesWith as $id => $games) {
147	1	$filter = array_filter($games, static function($key) use ($team) {
148	1	return $key === $team->getId();
149	1	}, ARRAY_FILTER_USE_KEY);
150	1	if (count($filter) > 0) {
151	1	$return[$id] = $filter;
152		}
153		}
154	1	return $return;
155		}
156	1	return $this->gamesWith;
157		}
158
159		/**
160		* Adds a group to a team and creates an array for all games to be played
161		*
162		* @param Group $group A group to add
163		*
164		* @return $this
165		*/
166	1	public function addGroup(Group $group) : Team {
167	1	if (!isset($this->games[$group->getId()])) {
168	1	$this->games[$group->getId()] = [];
169		}
170	1	return $this;
171		}
172
173		/**
174		* Adds a game to this team
175		*
176		* @param Game $game A game to add
177		*
178		* @return $this
179		*/
180	206	public function addGame(Game $game) : Team {
181	206	$group = $game->getGroup();
182	206	if (!isset($this->games[$group->getId()])) {
183	206	$this->games[$group->getId()] = [];
184		}
185	206	$this->games[$group->getId()][] = $game;
186	206	return $this;
187		}
188
189		/**
190		* Gets all game from given group
191		*
192		* @param Group\|null $group A group to get its game from
193		* @param string\|int\|null $groupId An id of group to get its game from
194		*
195		* @return array Games from a group or all games if both arguments are null
196		*/
197	4	public function getGames(?Group $group = null, $groupId = null) {
198	4	if (!is_null($group) && isset($this->games[$group->getId()])) {
199	1	return $this->games[$group->getId()];
200		}
201	4	if (isset($groupId, $this->games[$groupId])) {
202	3	return $this->games[$groupId];
203		}
204	1	return $this->games;
205		}
206
207		/**
208		* Prepares an export query for the object
209		*
210		* @return ExporterInterface Exporter for this class
211		*/
212	13	public function export() : ExporterInterface {
213	13	return TeamExporter::start($this);
214		}
215
216		/**
217		* Get seeding score
218		*
219		* @return int
220		*/
221	37	public function getSeed() : int {
222	37	return $this->seed;
223		}
224		}
225

Heroyt / tournament-generator

Push — master ( 228718...2540c1 )

Team::getSeed() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like