Alliance::getFaction() - Code Metrics - Inspection of "fix unit test" - st-universe/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3d9598...e4e562 )

by Nico

created 2023-12-04 08:59 UTC

Alliance::getFaction() A

↳ Parent: Alliance

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

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

<?php

declare(strict_types=1);

namespace Stu\Orm\Entity;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping\Column;
use Doctrine\ORM\Mapping\Entity;
use Doctrine\ORM\Mapping\GeneratedValue;
use Doctrine\ORM\Mapping\Id;
use Doctrine\ORM\Mapping\JoinColumn;
use Doctrine\ORM\Mapping\ManyToOne;
use Doctrine\ORM\Mapping\OneToMany;
use Doctrine\ORM\Mapping\Table;
use Stu\Component\Alliance\AllianceEnum;
use Stu\Component\Alliance\Exception\AllianceFounderNotSetException;

/**
 * @Entity(repositoryClass="Stu\Orm\Repository\AllianceRepository")
 * @Table(
 *     name="stu_alliances",
 *     indexes={
 *     }
 * )
 **/
class Alliance implements AllianceInterface
{
    /**
     * @Id
     * @Column(type="integer")
     * @GeneratedValue(strategy="IDENTITY")
     *
     */
    private int $id;

    /**
     * @Column(type="string")
     *
     */
    private string $name = '';

    /**
     * @Column(type="text")
     *
     */
    private string $description = '';

    /**
     * @Column(type="string")
     *
     */
    private string $homepage = '';

    /**
     * @Column(type="integer")
     *
     */
    private int $date = 0;

    /**
     * @Column(type="integer", nullable=true)
     *
     */
    private ?int $faction_id = null;


    /**
     * @Column(type="boolean")
     *
     */
    private bool $accept_applications = false;

    /**
     * @Column(type="string", length=32)
     *
     */
    private string $avatar = '';

    /**
     * @Column(type="string", length=7)
     *
     */
    private string $rgb_code = '';

    /**
     *
     * @ManyToOne(targetEntity="Faction")
     * @JoinColumn(name="faction_id", referencedColumnName="id")
     */
    private ?FactionInterface $faction = null;

    /**
     * @var ArrayCollection<int, UserInterface>
     *
     * @OneToMany(targetEntity="User", mappedBy="alliance")
     */
    private Collection $members;

    /**
     * @var ArrayCollection<int, AllianceJobInterface>
     *
     * @OneToMany(targetEntity="AllianceJob", mappedBy="alliance", indexBy="type")
     */
    private Collection $jobs;

    public function __construct()
    {
        $this->members = new ArrayCollection();
        $this->jobs = new ArrayCollection();
    }

    public function getId(): int
    {
        return $this->id;
    }

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

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

    public function getDescription(): string
    {
        return $this->description;
    }

    public function setDescription(string $description): AllianceInterface
    {
        $this->description = $description;
        return $this;
    }

    public function getHomepage(): string
    {
        return $this->homepage;
    }

    public function setHomepage(string $homepage): AllianceInterface
    {
        $this->homepage = $homepage;
        return $this;
    }

    public function getDate(): int
    {
        return $this->date;
    }

    public function setDate(int $date): AllianceInterface
    {
        $this->date = $date;
        return $this;
    }

    public function getFaction(): ?FactionInterface
    {
        return $this->faction;
    }

    public function setFaction(?FactionInterface $faction): AllianceInterface
    {
        $this->faction = $faction;
        return $this;
    }

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

    public function setAcceptApplications(bool $acceptApplications): AllianceInterface
    {
        $this->accept_applications = $acceptApplications;
        return $this;
    }

    public function hasAvatar(): bool
    {
        return strlen($this->getAvatar()) > 0;
    }

    public function getAvatar(): string
    {
        return $this->avatar;
    }

    public function setAvatar(string $avatar): AllianceInterface
    {
        $this->avatar = $avatar;
        return $this;
    }

    public function getRgbCode(): string
    {
        return $this->rgb_code;
    }

    public function setRgbCode(string $rgbCode): AllianceInterface
    {
        $this->rgb_code = $rgbCode;
        return $this;
    }

    /**
     * @throws AllianceFounderNotSetException
     */
    public function getFounder(): AllianceJobInterface
    {
        $job = $this->jobs->get(AllianceEnum::ALLIANCE_JOBS_FOUNDER);
        if ($job === null) {
            // alliance without founder? this should not happen
            throw new AllianceFounderNotSetException();
        }
        return $job;
    }

    public function getSuccessor(): ?AllianceJobInterface
    {
        return $this->jobs->get(AllianceEnum::ALLIANCE_JOBS_SUCCESSOR);
    }

    public function getDiplomatic(): ?AllianceJobInterface
    {
        return $this->jobs->get(AllianceEnum::ALLIANCE_JOBS_DIPLOMATIC);
    }

    public function getMembers(): Collection
    {
        return $this->members;
    }

    public function isNpcAlliance(): bool
    {
        $founder = $this->jobs->get(AllianceEnum::ALLIANCE_JOBS_FOUNDER);

        if ($founder === null) {
            return false;
        }

        return $founder->getUser()->isNpc();
    }

    public function getJobs(): Collection
    {
        return $this->jobs;
    }

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

    public function hasTranslation(): bool
    {
        $text = $this->getDescription();
        return strpos($text, '[translate]') !== false && strpos($text, '[/translate]') !== false;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Stu\Orm\Entity;
6
7			use Doctrine\Common\Collections\ArrayCollection;
8			use Doctrine\Common\Collections\Collection;
9			use Doctrine\ORM\Mapping\Column;
10			use Doctrine\ORM\Mapping\Entity;
11			use Doctrine\ORM\Mapping\GeneratedValue;
12			use Doctrine\ORM\Mapping\Id;
13			use Doctrine\ORM\Mapping\JoinColumn;
14			use Doctrine\ORM\Mapping\ManyToOne;
15			use Doctrine\ORM\Mapping\OneToMany;
16			use Doctrine\ORM\Mapping\Table;
17			use Stu\Component\Alliance\AllianceEnum;
18			use Stu\Component\Alliance\Exception\AllianceFounderNotSetException;
19
20			/**
21			* @Entity(repositoryClass="Stu\Orm\Repository\AllianceRepository")
22			* @Table(
23			* name="stu_alliances",
24			* indexes={
25			* }
26			* )
27			**/
28			class Alliance implements AllianceInterface
29			{
30			/**
31			* @Id
32			* @Column(type="integer")
33			* @GeneratedValue(strategy="IDENTITY")
34			*
35			*/
36			private int $id;
37
38			/**
39			* @Column(type="string")
40			*
41			*/
42			private string $name = '';
43
44			/**
45			* @Column(type="text")
46			*
47			*/
48			private string $description = '';
49
50			/**
51			* @Column(type="string")
52			*
53			*/
54			private string $homepage = '';
55
56			/**
57			* @Column(type="integer")
58			*
59			*/
60			private int $date = 0;
61
62			/**
63			* @Column(type="integer", nullable=true)
64			*
65			*/
66			private ?int $faction_id = null;
			0 ignored issues – show introduced 2023-12-03 21:35 UTC by Report Bug Copy Issue Report The private property `$faction_id` is not used, and could be removed. Loading history...
67
68			/**
69			* @Column(type="boolean")
70			*
71			*/
72			private bool $accept_applications = false;
73
74			/**
75			* @Column(type="string", length=32)
76			*
77			*/
78			private string $avatar = '';
79
80			/**
81			* @Column(type="string", length=7)
82			*
83			*/
84			private string $rgb_code = '';
85
86			/**
87			*
88			* @ManyToOne(targetEntity="Faction")
89			* @JoinColumn(name="faction_id", referencedColumnName="id")
90			*/
91			private ?FactionInterface $faction = null;
92
93			/**
94			* @var ArrayCollection<int, UserInterface>
95			*
96			* @OneToMany(targetEntity="User", mappedBy="alliance")
97			*/
98			private Collection $members;
99
100			/**
101			* @var ArrayCollection<int, AllianceJobInterface>
102			*
103			* @OneToMany(targetEntity="AllianceJob", mappedBy="alliance", indexBy="type")
104			*/
105			private Collection $jobs;
106
107			public function __construct()
108			{
109			$this->members = new ArrayCollection();
110			$this->jobs = new ArrayCollection();
111			}
112
113			public function getId(): int
114			{
115			return $this->id;
116			}
117
118			public function getName(): string
119			{
120			return $this->name;
121			}
122
123			public function setName(string $name): AllianceInterface
124			{
125			$this->name = $name;
126			return $this;
127			}
128
129			public function getDescription(): string
130			{
131			return $this->description;
132			}
133
134			public function setDescription(string $description): AllianceInterface
135			{
136			$this->description = $description;
137			return $this;
138			}
139
140			public function getHomepage(): string
141			{
142			return $this->homepage;
143			}
144
145			public function setHomepage(string $homepage): AllianceInterface
146			{
147			$this->homepage = $homepage;
148			return $this;
149			}
150
151			public function getDate(): int
152			{
153			return $this->date;
154			}
155
156			public function setDate(int $date): AllianceInterface
157			{
158			$this->date = $date;
159			return $this;
160			}
161
162			public function getFaction(): ?FactionInterface
163			{
164			return $this->faction;
165			}
166
167			public function setFaction(?FactionInterface $faction): AllianceInterface
168			{
169			$this->faction = $faction;
170			return $this;
171			}
172
173			public function getAcceptApplications(): bool
174			{
175			return $this->accept_applications;
176			}
177
178			public function setAcceptApplications(bool $acceptApplications): AllianceInterface
179			{
180			$this->accept_applications = $acceptApplications;
181			return $this;
182			}
183
184			public function hasAvatar(): bool
185			{
186			return strlen($this->getAvatar()) > 0;
187			}
188
189			public function getAvatar(): string
190			{
191			return $this->avatar;
192			}
193
194			public function setAvatar(string $avatar): AllianceInterface
195			{
196			$this->avatar = $avatar;
197			return $this;
198			}
199
200			public function getRgbCode(): string
201			{
202			return $this->rgb_code;
203			}
204
205			public function setRgbCode(string $rgbCode): AllianceInterface
206			{
207			$this->rgb_code = $rgbCode;
208			return $this;
209			}
210
211			/**
212			* @throws AllianceFounderNotSetException
213			*/
214			public function getFounder(): AllianceJobInterface
215			{
216			$job = $this->jobs->get(AllianceEnum::ALLIANCE_JOBS_FOUNDER);
217			if ($job === null) {
218			// alliance without founder? this should not happen
219			throw new AllianceFounderNotSetException();
220			}
221			return $job;
222			}
223
224			public function getSuccessor(): ?AllianceJobInterface
225			{
226			return $this->jobs->get(AllianceEnum::ALLIANCE_JOBS_SUCCESSOR);
227			}
228
229			public function getDiplomatic(): ?AllianceJobInterface
230			{
231			return $this->jobs->get(AllianceEnum::ALLIANCE_JOBS_DIPLOMATIC);
232			}
233
234			public function getMembers(): Collection
235			{
236			return $this->members;
237			}
238
239			public function isNpcAlliance(): bool
240			{
241			$founder = $this->jobs->get(AllianceEnum::ALLIANCE_JOBS_FOUNDER);
242
243			if ($founder === null) {
244			return false;
245			}
246
247			return $founder->getUser()->isNpc();
248			}
249
250			public function getJobs(): Collection
251			{
252			return $this->jobs;
253			}
254
255			public function __toString(): string
256			{
257			return $this->getName();
258			}
259
260			public function hasTranslation(): bool
261			{
262			$text = $this->getDescription();
263			return strpos($text, '[translate]') !== false && strpos($text, '[/translate]') !== false;
264			}
265			}
266

st-universe / core

Push — master ( 3d9598...e4e562 )

Alliance::getFaction() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like