TournamentGenerator\Containers\GameContainer

Complexity

Total Complexity

17

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Test Coverage

Coverage

78.79%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	incrementId()	0	11	5
A	getFirstIncrement()	0	2	1
A	addChild()	0	9	3
A	getAutoIncrement()	0	2	1
A	setAutoIncrement()	0	7	2
A	resetAutoIncrement()	0	13	5

<?php


namespace TournamentGenerator\Containers;

use Exception;
use InvalidArgumentException;

/**
 * Class GameContainer
 *
 * Special container for games.
 *
 * @package TournamentGenerator\Containers
 * @author  Tomáš Vojík <vojik@wboy.cz>
 * @since   0.4
 */
class GameContainer extends BaseContainer
{

	/** @var GameContainer[] Direct child containers */
	protected array $children = [];
	/** @var int First auto increment value for recalculating the ids */
	protected int $firstIncrement = 1;
	/** @var int Autoincrement for contained games */
	protected int $autoIncrement = 1;
	/** @var GameContainer|null Parent container reference */
	protected ?BaseContainer $parent;

	/**
	 * Increments the auto-incremented id
	 *
	 * @param GameContainer|null $sender
	 *
	 * @post  Propagates to all children but the sender
	 * @post  Propagates to the parent if not the sender
	 * @since 0.5
	 */
	public function incrementId(?GameContainer $sender = null) : void {
		// Increment
		$this->autoIncrement++;
		// Propagate to parent
		if (isset($this->parent) && $this->parent !== $sender) {
			$this->parent->incrementId($this);

The method incrementId() does not exist on TournamentGenerator\Containers\BaseContainer. It seems like you code against a sub-type of TournamentGenerator\Containers\BaseContainer such as TournamentGenerator\Containers\GameContainer.

The method incrementId() does not exist on null.

		}
		// Propagate to children
		foreach ($this->children as $child) {
			if ($child !== $sender) {
				$child->incrementId($this);
			}
		}
	}

	/**
	 * @return int
	 * @since 0.5
	 */
	public function getAutoIncrement() : int {
		return $this->autoIncrement;
	}

	/**
	 * Sets the autoincrement number for games
	 *
	 * @param int $autoIncrement
	 *
	 * @post  The value is propagated to child containers
	 * @post  The firstIncrement value is set too
	 *
	 * @return GameContainer
	 * @since 0.5
	 */
	public function setAutoIncrement(int $autoIncrement) : GameContainer {
		$this->autoIncrement = $autoIncrement;
		$this->firstIncrement = $autoIncrement;
		foreach ($this->children as $child) {
			$child->setAutoIncrement($autoIncrement);
		}
		return $this;
	}

	/**
	 * Resets the autoincrement number for games to the FirstIncrement
	 *
	 * @param GameContainer|null $sender
	 *
	 * @return GameContainer
	 * @post  Propagates to all children but the sender
	 * @post  Propagates to the parent if not the sender
	 *
	 * @since 0.5
	 */
	public function resetAutoIncrement(?GameContainer $sender = null) : GameContainer {
		$this->autoIncrement = $this->firstIncrement;
		// Propagate to parent
		if (isset($this->parent) && $this->parent !== $sender) {
			$this->parent->resetAutoIncrement($this);

The method resetAutoIncrement() does not exist on TournamentGenerator\Containers\BaseContainer. It seems like you code against a sub-type of TournamentGenerator\Containers\BaseContainer such as TournamentGenerator\Containers\GameContainer.

		}
		// Propagate to children
		foreach ($this->children as $child) {
			if ($child !== $sender) {
				$child->resetAutoIncrement($this);
			}
		}
		return $this;
	}

	/**
	 * @return int
	 * @since 0.5
	 */
	public function getFirstIncrement() : int {
		return $this->firstIncrement;
	}


	/**
	 * Adds a child container
	 *
	 * @param GameContainer[] $containers
	 *
	 * @return $this
	 * @post Parent container is set for the added children
	 * @post Autoincrement value is propagated to added child containers
	 * @throws Exception
	 */
	public function addChild(BaseContainer ...$containers) : BaseContainer {
		foreach ($containers as $container) {
			if (!$container instanceof self) {
				throw new InvalidArgumentException('GameContainer must contain only other GameContainers.');
			}
			$container->setAutoIncrement($this->autoIncrement);
		}
		parent::addChild(...$containers);
		return $this;
	}

}