AbstractPosition::getName() - Code Metrics - Inspection of "PHP CS Fixer" - obblm/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — v1.x-dev (59bcf7)

by Benjamin

created 2020-10-08 14:19 UTC

AbstractPosition::getName() A

↳ Parent: AbstractPosition

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Obblm\Core\Helper\Rule\Roster;

use Obblm\Core\Contracts\PositionInterface;
use Obblm\Core\Contracts\RosterInterface;
use Obblm\Core\Helper\Optionable;
use Symfony\Component\OptionsResolver\OptionsResolver;

abstract class AbstractPosition extends Optionable implements PositionInterface
{
    /** @var string */
    private $key;
    /** @var string */
    private $name;
    /** @var string */
    private $translationDomain;
    /** @var int */
    private $cost;
    /** @var int */
    private $min;
    /** @var int */
    private $max;
    /** @var bool */
    private $isJourneyman;
    /** @var array */
    private $characteristics;
    /** @var array */
    private $skills;
    /** @var array */
    private $availableSkills;
    /** @var array */
    private $availableSkillsOnDouble;
    /** @var roster */
    private $roster;

    protected function hydrateWithOptions()
    {
        $this->setKey($this->options['key'])
            ->setName($this->options['name'])
            ->setTranslationDomain($this->options['translation_domain'])
            ->setCharacteristics($this->options['characteristics'])
            ->setCost($this->options['cost'])
            ->setMin($this->options['min'])
            ->setMax($this->options['max'])
            ->setIsJourneyman($this->options['is_journeyman'])
            ->setSkills($this->options['skills'])
            ->setAvailableSkills($this->options['available_skills'])
            ->setAvailableSkillsOnDouble($this->options['available_skills_on_double'])
            ;
    }

    /**
     * @return string
     */
    public function getKey(): string
    {
        return $this->key;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    public function getMax(): int
    {
        return $this->max;
    }

    public function getCost(): int
    {
        return $this->cost;
    }

    public function isJourneyman(): bool
    {
        return $this->isJourneyman;
    }

    public function getIsJourneyman(): bool
    {
        return $this->isJourneyman;
    }

    /**
     * @return int
     */
    public function getMin(): int
    {
        return $this->min;
    }

    /**
     * @return array
     */
    public function getSkills(): array
    {
        return $this->skills;
    }

    /**
     * @return array
     */
    public function getCharacteristics(): array
    {
        return $this->characteristics;
    }

    /**
     * @return array
     */
    public function getAvailableSkills(): array
    {
        return $this->availableSkills;
    }

    /**
     * @return array
     */
    public function getAvailableSkillsOnDouble(): array
    {
        return $this->availableSkillsOnDouble;
    }

    /**
     * @return RosterInterface
     */
    public function getRoster(): RosterInterface
    {
        return $this->roster;
    }


    /**
     * @return string
     */
    public function getTranslationDomain(): string
    {
        return $this->translationDomain;
    }

    public function setKey(string $key): self
    {
        $this->key = $key;
        return $this;
    }

    public function setRoster(RosterInterface $roster): self
    {
        $this->roster = $roster;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        return $this;
    }

    public function setName(string $name): self
    {
        $this->name = $name;
        return $this;
    }

    public function setTranslationDomain(string $translationDomain): self
    {
        $this->translationDomain = $translationDomain;
        return $this;
    }

    /**
     * @param int $cost
     */
    public function setCost(int $cost): self
    {
        $this->cost = $cost;
        return $this;
    }

    /**
     * @param int $min
     */
    public function setMin(int $min): self
    {
        $this->min = $min;
        return $this;
    }

    /**
     * @param int $max
     */
    public function setMax(int $max): self
    {
        $this->max = $max;
        return $this;
    }

    /**
     * @param bool $isJouneyman
     */
    public function setIsJourneyman(bool $isJourneyman): self
    {
        $this->isJourneyman = $isJourneyman;
        return $this;
    }

    /**
     * @param array
     */
    public function setCharacteristics(array $characteristics): self
    {
        $this->characteristics = $characteristics;
        return $this;
    }

    /**
     * @param array $skills
     */
    public function setSkills(array $skills): self
    {
        $this->skills = $skills;
        return $this;
    }

    /**
     * @param array $availableSkills
     */
    public function setAvailableSkills(array $availableSkills): self
    {
        $this->availableSkills = $availableSkills;
        return $this;
    }

    /**
     * @param array $availableSkillsOnDouble
     */
    public function setAvailableSkillsOnDouble(array $availableSkillsOnDouble): self
    {
        $this->availableSkillsOnDouble = $availableSkillsOnDouble;
        return $this;
    }

    public function __toString(): string
    {
        return $this->name;
    }

    public function configureOptions(OptionsResolver $resolver):void
    {
        $resolver->setDefaults([
                'key' => null,
                'name' => null,
                'translation_domain' => null,
                'characteristics' => null,
                'skills' => [],
                'available_skills' => [],
                'available_skills_on_double' => [],
                'min' => 1,
                'max' => 1,
                'cost' => null,
                'is_journeyman' => false,
            ])
            ->setRequired(['key', 'name', 'translation_domain', 'characteristics'])
            ->setAllowedTypes('key', ['string'])
            ->setAllowedTypes('name', ['string'])
            ->setAllowedTypes('translation_domain', ['string'])
            ->setAllowedTypes('characteristics', ['array'])
            ->setAllowedTypes('skills', ['array'])
            ->setAllowedTypes('available_skills', ['array'])
            ->setAllowedTypes('available_skills_on_double', ['array'])
            ->setAllowedTypes('min', ['int'])
            ->setAllowedTypes('max', ['int'])
            ->setAllowedTypes('cost', ['int'])
            ->setAllowedTypes('is_journeyman', ['bool'])
        ;
    }
}


1		<?php
2
3		namespace Obblm\Core\Helper\Rule\Roster;
4
5		use Obblm\Core\Contracts\PositionInterface;
6		use Obblm\Core\Contracts\RosterInterface;
7		use Obblm\Core\Helper\Optionable;
8		use Symfony\Component\OptionsResolver\OptionsResolver;
9
10		abstract class AbstractPosition extends Optionable implements PositionInterface
11		{
12		/** @var string */
13		private $key;
14		/** @var string */
15		private $name;
16		/** @var string */
17		private $translationDomain;
18		/** @var int */
19		private $cost;
20		/** @var int */
21		private $min;
22		/** @var int */
23		private $max;
24		/** @var bool */
25		private $isJourneyman;
26		/** @var array */
27		private $characteristics;
28		/** @var array */
29		private $skills;
30		/** @var array */
31		private $availableSkills;
32		/** @var array */
33		private $availableSkillsOnDouble;
34		/** @var roster */
35		private $roster;
36
37	1	protected function hydrateWithOptions()
38		{
39	1	$this->setKey($this->options['key'])
40	1	->setName($this->options['name'])
41	1	->setTranslationDomain($this->options['translation_domain'])
42	1	->setCharacteristics($this->options['characteristics'])
43	1	->setCost($this->options['cost'])
44	1	->setMin($this->options['min'])
45	1	->setMax($this->options['max'])
46	1	->setIsJourneyman($this->options['is_journeyman'])
47	1	->setSkills($this->options['skills'])
48	1	->setAvailableSkills($this->options['available_skills'])
49	1	->setAvailableSkillsOnDouble($this->options['available_skills_on_double'])
50		;
51	1	}
52
53		/**
54		* @return string
55		*/
56		public function getKey(): string
57		{
58		return $this->key;
59		}
60
61		/**
62		* @return string
63		*/
64		public function getName(): string
65		{
66		return $this->name;
67		}
68
69	1	public function getMax(): int
70		{
71	1	return $this->max;
72		}
73
74		public function getCost(): int
75		{
76		return $this->cost;
77		}
78
79		public function isJourneyman(): bool
80		{
81		return $this->isJourneyman;
82		}
83
84		public function getIsJourneyman(): bool
85		{
86		return $this->isJourneyman;
87		}
88
89		/**
90		* @return int
91		*/
92		public function getMin(): int
93		{
94		return $this->min;
95		}
96
97		/**
98		* @return array
99		*/
100		public function getSkills(): array
101		{
102		return $this->skills;
103		}
104
105		/**
106		* @return array
107		*/
108		public function getCharacteristics(): array
109		{
110		return $this->characteristics;
111		}
112
113		/**
114		* @return array
115		*/
116		public function getAvailableSkills(): array
117		{
118		return $this->availableSkills;
119		}
120
121		/**
122		* @return array
123		*/
124		public function getAvailableSkillsOnDouble(): array
125		{
126		return $this->availableSkillsOnDouble;
127		}
128
129		/**
130		* @return RosterInterface
131		*/
132		public function getRoster(): RosterInterface
133		{
134		return $this->roster;
135		}
136
137
138		/**
139		* @return string
140		*/
141		public function getTranslationDomain(): string
142		{
143		return $this->translationDomain;
144		}
145
146	1	public function setKey(string $key): self
147		{
148	1	$this->key = $key;
149	1	return $this;
150		}
151
152	1	public function setRoster(RosterInterface $roster): self
153		{
154	1	$this->roster = $roster;
		0 ignored issues – show Documentation Bug introduced 2020-10-08 14:24 UTC by Report Bug Copy Issue Report `$roster` is of type `Obblm\Core\Contracts\RosterInterface`, but the property `$roster` was declared to be of type `Obblm\Core\Helper\Rule\Roster\roster`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
155	1	return $this;
156		}
157
158	1	public function setName(string $name): self
159		{
160	1	$this->name = $name;
161	1	return $this;
162		}
163
164	1	public function setTranslationDomain(string $translationDomain): self
165		{
166	1	$this->translationDomain = $translationDomain;
167	1	return $this;
168		}
169
170		/**
171		* @param int $cost
172		*/
173	1	public function setCost(int $cost): self
174		{
175	1	$this->cost = $cost;
176	1	return $this;
177		}
178
179		/**
180		* @param int $min
181		*/
182	1	public function setMin(int $min): self
183		{
184	1	$this->min = $min;
185	1	return $this;
186		}
187
188		/**
189		* @param int $max
190		*/
191	1	public function setMax(int $max): self
192		{
193	1	$this->max = $max;
194	1	return $this;
195		}
196
197		/**
198		* @param bool $isJouneyman
199		*/
200	1	public function setIsJourneyman(bool $isJourneyman): self
201		{
202	1	$this->isJourneyman = $isJourneyman;
203	1	return $this;
204		}
205
206		/**
207		* @param array
208		*/
209	1	public function setCharacteristics(array $characteristics): self
210		{
211	1	$this->characteristics = $characteristics;
212	1	return $this;
213		}
214
215		/**
216		* @param array $skills
217		*/
218	1	public function setSkills(array $skills): self
219		{
220	1	$this->skills = $skills;
221	1	return $this;
222		}
223
224		/**
225		* @param array $availableSkills
226		*/
227	1	public function setAvailableSkills(array $availableSkills): self
228		{
229	1	$this->availableSkills = $availableSkills;
230	1	return $this;
231		}
232
233		/**
234		* @param array $availableSkillsOnDouble
235		*/
236	1	public function setAvailableSkillsOnDouble(array $availableSkillsOnDouble): self
237		{
238	1	$this->availableSkillsOnDouble = $availableSkillsOnDouble;
239	1	return $this;
240		}
241
242		public function __toString(): string
243		{
244		return $this->name;
245		}
246
247	1	public function configureOptions(OptionsResolver $resolver):void
248		{
249	1	$resolver->setDefaults([
250	1	'key' => null,
251		'name' => null,
252		'translation_domain' => null,
253		'characteristics' => null,
254		'skills' => [],
255		'available_skills' => [],
256		'available_skills_on_double' => [],
257		'min' => 1,
258		'max' => 1,
259		'cost' => null,
260		'is_journeyman' => false,
261		])
262	1	->setRequired(['key', 'name', 'translation_domain', 'characteristics'])
263	1	->setAllowedTypes('key', ['string'])
264	1	->setAllowedTypes('name', ['string'])
265	1	->setAllowedTypes('translation_domain', ['string'])
266	1	->setAllowedTypes('characteristics', ['array'])
267	1	->setAllowedTypes('skills', ['array'])
268	1	->setAllowedTypes('available_skills', ['array'])
269	1	->setAllowedTypes('available_skills_on_double', ['array'])
270	1	->setAllowedTypes('min', ['int'])
271	1	->setAllowedTypes('max', ['int'])
272	1	->setAllowedTypes('cost', ['int'])
273	1	->setAllowedTypes('is_journeyman', ['bool'])
274		;
275	1	}
276		}
277

obblm / core

Branch — v1.x-dev (59bcf7)

AbstractPosition::getName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like