Alliance::setFaction() - Code Metrics - Inspection of "rework ally job" - st-universe/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ad0a87...920d42 )

by Nico

created 2025-10-22 19:15 UTC

Alliance::setFaction() A

↳ Parent: Alliance

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
ccs	0
cts	3
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\Enum\AllianceJobTypeEnum;
use Stu\Component\Alliance\Exception\AllianceFounderNotSetException;
use Stu\Orm\Attribute\TruncateOnGameReset;
use Stu\Orm\Repository\AllianceRepository;

#[Table(name: 'stu_alliances')]
#[Entity(repositoryClass: AllianceRepository::class)]
#[TruncateOnGameReset]
class Alliance
{
    #[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::class)]
    #[JoinColumn(name: 'faction_id', referencedColumnName: 'id')]
    private ?Faction $faction = null;

    /**
     * @var ArrayCollection<int, AllianceSettings>
     */
    #[OneToMany(targetEntity: AllianceSettings::class, mappedBy: 'alliance')]
    private Collection $settings;


    /**
     * @var ArrayCollection<int, User>
     */
    #[OneToMany(targetEntity: User::class, mappedBy: 'alliance')]
    private Collection $members;

    /**
     * @var ArrayCollection<int, AllianceJob>
     */
    #[OneToMany(targetEntity: AllianceJob::class, mappedBy: 'alliance')]
    private Collection $jobs;


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

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

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

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

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

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

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

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

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

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

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

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

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

    public function setAcceptApplications(bool $acceptApplications): Alliance
    {
        $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): Alliance
    {
        $this->avatar = $avatar;
        return $this;
    }

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

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

    /**
     * @throws AllianceFounderNotSetException
     */
    public function getFounder(): AllianceJob
    {
        foreach ($this->jobs as $job) {
            if ($job->hasFounderPermission()) {
                return $job;
            }
        }
        throw new AllianceFounderNotSetException();
    }

    public function getSuccessor(): ?AllianceJob
    {
        foreach ($this->jobs as $job) {
            if ($job->hasSuccessorPermission() && !$job->hasFounderPermission()) {
                return $job;
            }
        }
        return null;
    }

    public function getDiplomatic(): ?AllianceJob
    {
        foreach ($this->jobs as $job) {
            if ($job->hasDiplomaticPermission() && !$job->hasFounderPermission() && !$job->hasSuccessorPermission()) {
                return $job;
            }
        }
        return null;
    }

    /**
     * @return array<AllianceJob>
     */
    public function getJobsWithFounderPermission(): array
    {
        return array_values(array_filter(
            $this->jobs->toArray(),
            fn(AllianceJob $job) => $job->hasFounderPermission()
        ));
    }

    /**
     * @return array<AllianceJob>
     */
    public function getJobsWithSuccessorPermission(): array
    {
        return array_values(array_filter(
            $this->jobs->toArray(),
            fn(AllianceJob $job) => $job->hasSuccessorPermission()
        ));
    }

    /**
     * @return array<AllianceJob>
     */
    public function getJobsWithDiplomaticPermission(): array
    {
        return array_values(array_filter(
            $this->jobs->toArray(),
            fn(AllianceJob $job) => $job->hasDiplomaticPermission()
        ));
    }

    /**
     * @return Collection<int, User>
     */
    public function getMembers(): Collection
    {
        return $this->members;
    }

    /**
     * Returns `true` if the founder is a npc
     */
    public function isNpcAlliance(): bool
    {
        try {
            $founder = $this->getFounder();

            foreach ($founder->getMemberAssignments() as $assignment) {
                if ($assignment->getUser()->isNpc()) {
                    return true;
                }
            }
        } catch (AllianceFounderNotSetException) {
            return false;
        }

        return false;
    }

    /**
     * Returns the alliance jobs, indexed by type
     *
     * @return Collection<int, AllianceJob>
     */
    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;
    }

    /**
     * @return Collection<int, AllianceSettings>
     */
    public function getSettings(): Collection
    {
        return $this->settings;
    }
}


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\Enum\AllianceJobTypeEnum;
18		use Stu\Component\Alliance\Exception\AllianceFounderNotSetException;
19		use Stu\Orm\Attribute\TruncateOnGameReset;
20		use Stu\Orm\Repository\AllianceRepository;
21
22		#[Table(name: 'stu_alliances')]
23		#[Entity(repositoryClass: AllianceRepository::class)]
24		#[TruncateOnGameReset]
25		class Alliance
26		{
27		#[Id]
28		#[Column(type: 'integer')]
29		#[GeneratedValue(strategy: 'IDENTITY')]
30		private int $id;
31
32		#[Column(type: 'string')]
33		private string $name = '';
34
35		#[Column(type: 'text')]
36		private string $description = '';
37
38		#[Column(type: 'string')]
39		private string $homepage = '';
40
41		#[Column(type: 'integer')]
42		private int $date = 0;
43
44		#[Column(type: 'integer', nullable: true)]
45		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...
46
47		#[Column(type: 'boolean')]
48		private bool $accept_applications = false;
49
50		#[Column(type: 'string', length: 32)]
51		private string $avatar = '';
52
53		#[Column(type: 'string', length: 7)]
54		private string $rgb_code = '';
55
56		#[ManyToOne(targetEntity: Faction::class)]
57		#[JoinColumn(name: 'faction_id', referencedColumnName: 'id')]
58		private ?Faction $faction = null;
59
60		/**
61		* @var ArrayCollection<int, AllianceSettings>
62		*/
63		#[OneToMany(targetEntity: AllianceSettings::class, mappedBy: 'alliance')]
64		private Collection $settings;
65
66
67		/**
68		* @var ArrayCollection<int, User>
69		*/
70		#[OneToMany(targetEntity: User::class, mappedBy: 'alliance')]
71		private Collection $members;
72
73		/**
74		* @var ArrayCollection<int, AllianceJob>
75		*/
76		#[OneToMany(targetEntity: AllianceJob::class, mappedBy: 'alliance')]
77		private Collection $jobs;
78
79
80		public function __construct()
81		{
82		$this->members = new ArrayCollection();
83		$this->jobs = new ArrayCollection();
84		$this->settings = new ArrayCollection();
85		}
86
87	21	public function getId(): int
88		{
89	21	return $this->id;
90		}
91
92	9	public function getName(): string
93		{
94	9	return $this->name;
95		}
96
97		public function setName(string $name): Alliance
98		{
99		$this->name = $name;
100		return $this;
101		}
102
103	2	public function getDescription(): string
104		{
105	2	return $this->description;
106		}
107
108		public function setDescription(string $description): Alliance
109		{
110		$this->description = $description;
111		return $this;
112		}
113
114	1	public function getHomepage(): string
115		{
116	1	return $this->homepage;
117		}
118
119		public function setHomepage(string $homepage): Alliance
120		{
121		$this->homepage = $homepage;
122		return $this;
123		}
124
125	1	public function getDate(): int
126		{
127	1	return $this->date;
128		}
129
130		public function setDate(int $date): Alliance
131		{
132		$this->date = $date;
133		return $this;
134		}
135
136	1	public function getFaction(): ?Faction
137		{
138	1	return $this->faction;
139		}
140
141		public function setFaction(?Faction $faction): Alliance
142		{
143		$this->faction = $faction;
144		return $this;
145		}
146
147	2	public function getAcceptApplications(): bool
148		{
149	2	return $this->accept_applications;
150		}
151
152		public function setAcceptApplications(bool $acceptApplications): Alliance
153		{
154		$this->accept_applications = $acceptApplications;
155		return $this;
156		}
157
158		public function hasAvatar(): bool
159		{
160		return strlen($this->getAvatar()) > 0;
161		}
162
163	1	public function getAvatar(): string
164		{
165	1	return $this->avatar;
166		}
167
168		public function setAvatar(string $avatar): Alliance
169		{
170		$this->avatar = $avatar;
171		return $this;
172		}
173
174	1	public function getRgbCode(): string
175		{
176	1	return $this->rgb_code;
177		}
178
179		public function setRgbCode(string $rgbCode): Alliance
180		{
181		$this->rgb_code = $rgbCode;
182		return $this;
183		}
184
185		/**
186		* @throws AllianceFounderNotSetException
187		*/
188		public function getFounder(): AllianceJob
189		{
190		foreach ($this->jobs as $job) {
191		if ($job->hasFounderPermission()) {
192		return $job;
193		}
194		}
195		throw new AllianceFounderNotSetException();
196		}
197
198		public function getSuccessor(): ?AllianceJob
199		{
200		foreach ($this->jobs as $job) {
201		if ($job->hasSuccessorPermission() && !$job->hasFounderPermission()) {
202		return $job;
203		}
204		}
205		return null;
206		}
207
208		public function getDiplomatic(): ?AllianceJob
209		{
210		foreach ($this->jobs as $job) {
211		if ($job->hasDiplomaticPermission() && !$job->hasFounderPermission() && !$job->hasSuccessorPermission()) {
212		return $job;
213		}
214		}
215		return null;
216		}
217
218		/**
219		* @return array<AllianceJob>
220		*/
221	1	public function getJobsWithFounderPermission(): array
222		{
223	1	return array_values(array_filter(
224	1	$this->jobs->toArray(),
225	1	fn(AllianceJob $job) => $job->hasFounderPermission()
226	1	));
227		}
228
229		/**
230		* @return array<AllianceJob>
231		*/
232		public function getJobsWithSuccessorPermission(): array
233		{
234		return array_values(array_filter(
235		$this->jobs->toArray(),
236		fn(AllianceJob $job) => $job->hasSuccessorPermission()
237		));
238		}
239
240		/**
241		* @return array<AllianceJob>
242		*/
243		public function getJobsWithDiplomaticPermission(): array
244		{
245		return array_values(array_filter(
246		$this->jobs->toArray(),
247		fn(AllianceJob $job) => $job->hasDiplomaticPermission()
248		));
249		}
250
251		/**
252		* @return Collection<int, User>
253		*/
254	2	public function getMembers(): Collection
255		{
256	2	return $this->members;
257		}
258
259		/**
260		* Returns `true` if the founder is a npc
261		*/
262		public function isNpcAlliance(): bool
263		{
264		try {
265		$founder = $this->getFounder();
266
267		foreach ($founder->getMemberAssignments() as $assignment) {
268		if ($assignment->getUser()->isNpc()) {
269		return true;
270		}
271		}
272		} catch (AllianceFounderNotSetException) {
273		return false;
274		}
275
276		return false;
277		}
278
279		/**
280		* Returns the alliance jobs, indexed by type
281		*
282		* @return Collection<int, AllianceJob>
283		*/
284	3	public function getJobs(): Collection
285		{
286	3	return $this->jobs;
287		}
288
289		public function __toString(): string
290		{
291		return $this->getName();
292		}
293
294	1	public function hasTranslation(): bool
295		{
296	1	$text = $this->getDescription();
297	1	return strpos($text, '[translate]') !== false && strpos($text, '[/translate]') !== false;
298		}
299
300		/**
301		* @return Collection<int, AllianceSettings>
302		*/
303	1	public function getSettings(): Collection
304		{
305	1	return $this->settings;
306		}
307		}
308

st-universe / core

Push — master ( ad0a87...920d42 )

Alliance::setFaction() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like