WithCategories::getCategories() - Code Metrics - Inspection of ":memo: API documentation" - Heroyt/tournament-generator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 795926...7012fc )

by Tomáš

created 2021-05-21 09:47 UTC

WithCategories::getCategories() A

↳ Parent: WithCategories

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	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
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\Traits;


use TournamentGenerator\Category;
use TournamentGenerator\Interfaces\WithCategories as WithCategoriesInterface;

/**
 * Definitions of methods for objects that contain categories
 *
 * @author  Tomáš Vojík <[email protected]>
 * @package TournamentGenerator\Traits
 * @since   0.4
 */
trait WithCategories
{

	/** @var Category[] */
	protected array $categories = [];

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


	/**
	 * 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->categories[] = $category;
		}
		return $this;

	}

	/**
	 * Creates a new category and adds it to the object
	 *
	 * @param string $name New category name
	 * @param 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->categories[] = $c->setSkip($this->allowSkip);
		return $c;
	}

}

1		<?php
2
3
4		namespace TournamentGenerator\Traits;
5
6
7		use TournamentGenerator\Category;
8		use TournamentGenerator\Interfaces\WithCategories as WithCategoriesInterface;
9
10		/**
11		* Definitions of methods for objects that contain categories
12		*
13		* @author Tomáš Vojík <[email protected]>
14		* @package TournamentGenerator\Traits
15		* @since 0.4
16		*/
17		trait WithCategories
18		{
19
20		/** @var Category[] */
21		protected array $categories = [];
22
23		/**
24		* Get all categories
25		*
26		* @return Category[]
27		*/
28	36	public function getCategories() : array {
29	36	return $this->categories;
30		}
31
32
33		/**
34		* Add one or more category to object
35		*
36		* @param Category ...$categories Category objects
37		*
38		* @return $this
39		*/
40	1	public function addCategory(Category ...$categories) : WithCategoriesInterface {
41	1	foreach ($categories as $category) {
42	1	$this->categories[] = $category;
43		}
44	1	return $this;
		1 ignored issue – show Bug Best Practice introduced 2021-05-21 09:58 UTC by Report Bug Copy Issue Report The expression `return $this` returns the type `TournamentGenerator\Traits\WithCategories` which is incompatible with the type-hinted return `TournamentGenerator\Interfaces\WithCategories`. Loading history...
45		}
46
47		/**
48		* Creates a new category and adds it to the object
49		*
50		* @param string $name New category name
51		* @param null $id Id of the new category - if omitted -> it is generated automatically as unique string
		0 ignored issues – show Documentation Bug introduced 2021-05-21 09:58 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$id` is correct as it would always require `null` to be passed? Loading history...
52		*
53		* @return Category New category
54		*/
55	8	public function category(string $name = '', $id = null) : Category {
56	8	$c = new Category($name, $id);
57	8	$this->categories[] = $c->setSkip($this->allowSkip);
58	8	return $c;
59		}
60
61		}

Heroyt / tournament-generator

Push — master ( 795926...7012fc )

WithCategories::getCategories() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like