TournamentGenerator\Traits\WithCategories

Complexity

Total Complexity

5

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	queryCategories()	0	2	1
A	category()	0	4	1
A	addCategory()	0	5	2
A	getCategories()	0	2	1

<?php


namespace TournamentGenerator\Traits;


use TournamentGenerator\Category;
use TournamentGenerator\Containers\BaseContainer;
use TournamentGenerator\Containers\ContainerQuery;
use TournamentGenerator\Interfaces\WithCategories as WithCategoriesInterface;

/**
 * Definitions of methods for objects that contain categories
 *
 * @author  Tomáš Vojík <vojik@wboy.cz>
 * @package TournamentGenerator\Traits
 * @since   0.4
 */
trait WithCategories
{

	/**
	 * Get all categories
	 *
	 * @return Category[]
	 */
	public function getCategories() : array {
		return $this->container->getHierarchyLevel(Category::class);
	}

	/**
	 * Get categories container query
	 *
	 * @return ContainerQuery
	 */
	public function queryCategories() : ContainerQuery {
		return $this->container->getHierarchyLevelQuery(Category::class);
	}


	/**
	 * Add one or more category to object
	 *
	 * @param Category ...$categories Category objects
	 *
	 * @return $this
	 */
	public function addCategory(Category ...$categories) : WithCategoriesInterface {
		foreach ($categories as $category) {
			$this->insertIntoContainer($category);
		}
		return $this;
	}

	/**
	 * Creates a new category and adds it to the object
	 *
	 * @param string $name New category name
	 * @param string|int|null   $id   Id of the new category - if omitted -> it is generated automatically as unique string
	 *
	 * @return Category New category
	 */
	public function category(string $name = '', $id = null) : Category {
		$c = new Category($name, $id);
		$this->insertIntoContainer($c->setSkip($this->allowSkip));
		return $c;
	}

}