Map::getSectorString() - Code Metrics - Inspection of "move base_damage to weapon system data" - st-universe/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev ( 98511f...00baf5 )

by Janko

created 2025-06-03 17:48 UTC

Map::getSectorString() A

↳ Parent: Map

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
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\Index;
use Doctrine\ORM\Mapping\JoinColumn;
use Doctrine\ORM\Mapping\ManyToOne;
use Doctrine\ORM\Mapping\OneToMany;
use Doctrine\ORM\Mapping\OneToOne;
use Doctrine\ORM\Mapping\Table;
use Override;
filter:
    dependency_paths: ["lib/*"]
use RuntimeException;
use Stu\Component\Map\MapEnum;
filter:
    dependency_paths: ["lib/*"]
use Stu\Orm\Repository\MapRepository;

#[Table(name: 'stu_map')]
#[Index(name: 'map_system_idx', columns: ['systems_id'])]
#[Index(name: 'map_system_type_idx', columns: ['system_type_id'])]
#[Index(name: 'map_influence_area_idx', columns: ['influence_area_id'])]
#[Index(name: 'map_bordertype_idx', columns: ['bordertype_id'])]
#[Index(name: 'map_admin_region_idx', columns: ['admin_region_id'])]
#[Entity(repositoryClass: MapRepository::class)]
class Map extends Location implements MapInterface
{
    #[Column(type: 'integer', nullable: true)]
    private ?int $system_type_id = null;

    #[Column(type: 'integer', nullable: true)]
    private ?int $systems_id = 0;


    #[Column(type: 'integer', nullable: true)]
    private ?int $influence_area_id = 0;

    #[Column(type: 'integer', nullable: true)]
    private ?int $bordertype_id = 0;

    #[Column(type: 'integer', nullable: true)]
    private ?int $region_id = 0;

    #[Column(type: 'integer', nullable: true)]
    private ?int $admin_region_id = null;

    #[OneToOne(targetEntity: 'StarSystem', inversedBy: 'map')]
    #[JoinColumn(name: 'systems_id', referencedColumnName: 'id')]
    private ?StarSystemInterface $starSystem = null;

    #[ManyToOne(targetEntity: 'StarSystem')]
    #[JoinColumn(name: 'influence_area_id', referencedColumnName: 'id')]
    private ?StarSystemInterface $influenceArea = null;

    #[ManyToOne(targetEntity: 'StarSystemType')]
    #[JoinColumn(name: 'system_type_id', referencedColumnName: 'id')]
    private ?StarSystemTypeInterface $starSystemType = null;

    #[ManyToOne(targetEntity: 'MapBorderType')]
    #[JoinColumn(name: 'bordertype_id', referencedColumnName: 'id')]
    private ?MapBorderTypeInterface $mapBorderType = null;

    #[ManyToOne(targetEntity: 'MapRegion')]
    #[JoinColumn(name: 'region_id', referencedColumnName: 'id')]
    private ?MapRegionInterface $mapRegion = null;

    #[ManyToOne(targetEntity: 'MapRegion')]
    #[JoinColumn(name: 'admin_region_id', referencedColumnName: 'id')]
    private ?MapRegionInterface $administratedRegion = null;

    /**
     * @var ArrayCollection<int, WormholeEntryInterface>
     */
    #[OneToMany(targetEntity: 'WormholeEntry', mappedBy: 'map')]
    private Collection $wormholeEntries;

    public function __construct()
    {
        parent::__construct();
        $this->wormholeEntries = new ArrayCollection();
    }

    #[Override]
    public function getLayer(): ?LayerInterface
    {
        if ($this->layer === null) {
            throw new RuntimeException('Layer of Map can not be null');
        }
        return $this->layer;
    }

    #[Override]
    public function getX(): int
    {
        if ($this->getCx() === null) {
            throw new RuntimeException('Cx of Map can not be null');
        }
        return $this->getCx();
    }

    #[Override]
    public function getY(): int
    {
        if ($this->getCy() === null) {
            throw new RuntimeException('Cy of Map can not be null');
        }
        return $this->getCy();
    }

    #[Override]
    public function getSystemTypeId(): ?int
    {
        return $this->system_type_id;
    }

    #[Override]
    public function setSystemTypeId(?int $system_type_id): MapInterface
    {
        $this->system_type_id = $system_type_id;
        return $this;
    }

    #[Override]
    public function getInfluenceAreaId(): ?int
    {
        return $this->influence_area_id;
    }

    #[Override]
    public function setInfluenceAreaId(?int $influenceAreaId): MapInterface
    {
        $this->influence_area_id = $influenceAreaId;
        return $this;
    }

    #[Override]
    public function getBordertypeId(): ?int
    {
        return $this->bordertype_id;
    }

    #[Override]
    public function setBordertypeId(?int $bordertype_id): MapInterface
    {
        $this->bordertype_id = $bordertype_id;
        return $this;
    }

    #[Override]
    public function getRegionId(): ?int
    {
        return $this->region_id;
    }

    #[Override]
    public function setRegionId(?int $region_id): MapInterface
    {
        $this->region_id = $region_id;
        return $this;
    }

    #[Override]
    public function getAdminRegionId(): ?int
    {
        return $this->admin_region_id;
    }

    #[Override]
    public function setAdminRegionId(?int $admin_region_id): MapInterface
    {
        $this->admin_region_id = $admin_region_id;
        return $this;
    }

    #[Override]
    public function getSystem(): ?StarSystemInterface
    {
        return $this->starSystem;
    }

    #[Override]
    public function setSystem(StarSystemInterface $starSystem): MapInterface
    {
        $this->starSystem = $starSystem;
        return $this;
    }

    #[Override]
    public function getInfluenceArea(): ?StarSystemInterface
    {
        return $this->influenceArea;
    }

    #[Override]
    public function setInfluenceArea(?StarSystemInterface $influenceArea): MapInterface
    {
        $this->influenceArea = $influenceArea;
        return $this;
    }

    #[Override]
    public function getStarSystemType(): ?StarSystemTypeInterface
    {
        return $this->starSystemType;
    }

    #[Override]
    public function getMapBorderType(): ?MapBorderTypeInterface
    {
        return $this->mapBorderType;
    }

    #[Override]
    public function getMapRegion(): ?MapRegionInterface
    {
        return $this->mapRegion;
    }

    #[Override]
    public function getAdministratedRegion(): ?MapRegionInterface
    {
        return $this->administratedRegion;
    }

    public function getBorder(): string
    {
        $borderType = $this->getMapBorderType();
        if ($borderType === null) {
            return '';
        }
        return 'border: 1px solid ' . $borderType->getColor();
    }

    public function getBorderColor(): string
    {
        $borderType = $this->getMapBorderType();
        if ($borderType === null) {
            return '';
        }
        return $borderType->getColor();
    }

    #[Override]
    protected function getWormholeEntries(): Collection
    {
        return $this->wormholeEntries;
    }

    #[Override]
    public function getSectorId(): ?int
    {
        $layer = $this->getLayer();
        if ($layer === null) {
            throw new RuntimeException('Layer of Map can not be null');
        }

        $cx = $this->getCx();
        $cy = $this->getCy();
        if ($cx === null || $cy === null) {
            throw new RuntimeException('Cx and Cy of Map can not be null');
        }

        return $layer->getSectorId(
            (int) ceil($cx / MapEnum::FIELDS_PER_SECTION),
            (int) ceil($cy / MapEnum::FIELDS_PER_SECTION)
        );
    }

    #[Override]
    public function getSectorString(): string
    {
        return  $this->getCx() . '|' . $this->getCy();
    }
}


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\Index;
12		use Doctrine\ORM\Mapping\JoinColumn;
13		use Doctrine\ORM\Mapping\ManyToOne;
14		use Doctrine\ORM\Mapping\OneToMany;
15		use Doctrine\ORM\Mapping\OneToOne;
16		use Doctrine\ORM\Mapping\Table;
17		use Override;
		0 ignored issues – show Bug introduced 2024-07-04 06:34 UTC by Report Bug Copy Issue Report The type `Override` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
18		use RuntimeException;
19		use Stu\Component\Map\MapEnum;
		0 ignored issues – show Bug introduced 2024-07-04 06:34 UTC by Report Bug Copy Issue Report The type `Stu\Component\Map\MapEnum` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
20		use Stu\Orm\Repository\MapRepository;
21
22		#[Table(name: 'stu_map')]
23		#[Index(name: 'map_system_idx', columns: ['systems_id'])]
24		#[Index(name: 'map_system_type_idx', columns: ['system_type_id'])]
25		#[Index(name: 'map_influence_area_idx', columns: ['influence_area_id'])]
26		#[Index(name: 'map_bordertype_idx', columns: ['bordertype_id'])]
27		#[Index(name: 'map_admin_region_idx', columns: ['admin_region_id'])]
28		#[Entity(repositoryClass: MapRepository::class)]
29		class Map extends Location implements MapInterface
30		{
31		#[Column(type: 'integer', nullable: true)]
32		private ?int $system_type_id = null;
33
34		#[Column(type: 'integer', nullable: true)]
35		private ?int $systems_id = 0;
		0 ignored issues – show introduced 2025-06-03 18:03 UTC by Report Bug Copy Issue Report The private property `$systems_id` is not used, and could be removed. Loading history...
36
37		#[Column(type: 'integer', nullable: true)]
38		private ?int $influence_area_id = 0;
39
40		#[Column(type: 'integer', nullable: true)]
41		private ?int $bordertype_id = 0;
42
43		#[Column(type: 'integer', nullable: true)]
44		private ?int $region_id = 0;
45
46		#[Column(type: 'integer', nullable: true)]
47		private ?int $admin_region_id = null;
48
49		#[OneToOne(targetEntity: 'StarSystem', inversedBy: 'map')]
50		#[JoinColumn(name: 'systems_id', referencedColumnName: 'id')]
51		private ?StarSystemInterface $starSystem = null;
52
53		#[ManyToOne(targetEntity: 'StarSystem')]
54		#[JoinColumn(name: 'influence_area_id', referencedColumnName: 'id')]
55		private ?StarSystemInterface $influenceArea = null;
56
57		#[ManyToOne(targetEntity: 'StarSystemType')]
58		#[JoinColumn(name: 'system_type_id', referencedColumnName: 'id')]
59		private ?StarSystemTypeInterface $starSystemType = null;
60
61		#[ManyToOne(targetEntity: 'MapBorderType')]
62		#[JoinColumn(name: 'bordertype_id', referencedColumnName: 'id')]
63		private ?MapBorderTypeInterface $mapBorderType = null;
64
65		#[ManyToOne(targetEntity: 'MapRegion')]
66		#[JoinColumn(name: 'region_id', referencedColumnName: 'id')]
67		private ?MapRegionInterface $mapRegion = null;
68
69		#[ManyToOne(targetEntity: 'MapRegion')]
70		#[JoinColumn(name: 'admin_region_id', referencedColumnName: 'id')]
71		private ?MapRegionInterface $administratedRegion = null;
72
73		/**
74		* @var ArrayCollection<int, WormholeEntryInterface>
75		*/
76		#[OneToMany(targetEntity: 'WormholeEntry', mappedBy: 'map')]
77		private Collection $wormholeEntries;
78
79		public function __construct()
80		{
81		parent::__construct();
82		$this->wormholeEntries = new ArrayCollection();
83		}
84
85	9	#[Override]
86		public function getLayer(): ?LayerInterface
87		{
88	9	if ($this->layer === null) {
89		throw new RuntimeException('Layer of Map can not be null');
90		}
91	9	return $this->layer;
92		}
93
94	2	#[Override]
95		public function getX(): int
96		{
97	2	if ($this->getCx() === null) {
98		throw new RuntimeException('Cx of Map can not be null');
99		}
100	2	return $this->getCx();
101		}
102
103	2	#[Override]
104		public function getY(): int
105		{
106	2	if ($this->getCy() === null) {
107		throw new RuntimeException('Cy of Map can not be null');
108		}
109	2	return $this->getCy();
110		}
111
112	1	#[Override]
113		public function getSystemTypeId(): ?int
114		{
115	1	return $this->system_type_id;
116		}
117
118		#[Override]
119		public function setSystemTypeId(?int $system_type_id): MapInterface
120		{
121		$this->system_type_id = $system_type_id;
122		return $this;
123		}
124
125	1	#[Override]
126		public function getInfluenceAreaId(): ?int
127		{
128	1	return $this->influence_area_id;
129		}
130
131		#[Override]
132		public function setInfluenceAreaId(?int $influenceAreaId): MapInterface
133		{
134		$this->influence_area_id = $influenceAreaId;
135		return $this;
136		}
137
138		#[Override]
139		public function getBordertypeId(): ?int
140		{
141		return $this->bordertype_id;
142		}
143
144		#[Override]
145		public function setBordertypeId(?int $bordertype_id): MapInterface
146		{
147		$this->bordertype_id = $bordertype_id;
148		return $this;
149		}
150
151	1	#[Override]
152		public function getRegionId(): ?int
153		{
154	1	return $this->region_id;
155		}
156
157		#[Override]
158		public function setRegionId(?int $region_id): MapInterface
159		{
160		$this->region_id = $region_id;
161		return $this;
162		}
163
164	1	#[Override]
165		public function getAdminRegionId(): ?int
166		{
167	1	return $this->admin_region_id;
168		}
169
170		#[Override]
171		public function setAdminRegionId(?int $admin_region_id): MapInterface
172		{
173		$this->admin_region_id = $admin_region_id;
174		return $this;
175		}
176
177	2	#[Override]
178		public function getSystem(): ?StarSystemInterface
179		{
180	2	return $this->starSystem;
181		}
182
183		#[Override]
184		public function setSystem(StarSystemInterface $starSystem): MapInterface
185		{
186		$this->starSystem = $starSystem;
187		return $this;
188		}
189
190	2	#[Override]
191		public function getInfluenceArea(): ?StarSystemInterface
192		{
193	2	return $this->influenceArea;
194		}
195
196		#[Override]
197		public function setInfluenceArea(?StarSystemInterface $influenceArea): MapInterface
198		{
199		$this->influenceArea = $influenceArea;
200		return $this;
201		}
202
203		#[Override]
204		public function getStarSystemType(): ?StarSystemTypeInterface
205		{
206		return $this->starSystemType;
207		}
208
209	1	#[Override]
210		public function getMapBorderType(): ?MapBorderTypeInterface
211		{
212	1	return $this->mapBorderType;
213		}
214
215	3	#[Override]
216		public function getMapRegion(): ?MapRegionInterface
217		{
218	3	return $this->mapRegion;
219		}
220
221	3	#[Override]
222		public function getAdministratedRegion(): ?MapRegionInterface
223		{
224	3	return $this->administratedRegion;
225		}
226
227		public function getBorder(): string
228		{
229		$borderType = $this->getMapBorderType();
230		if ($borderType === null) {
231		return '';
232		}
233		return 'border: 1px solid ' . $borderType->getColor();
234		}
235
236	1	public function getBorderColor(): string
237		{
238	1	$borderType = $this->getMapBorderType();
239	1	if ($borderType === null) {
240	1	return '';
241		}
242		return $borderType->getColor();
243		}
244
245	2	#[Override]
246		protected function getWormholeEntries(): Collection
247		{
248	2	return $this->wormholeEntries;
249		}
250
251	1	#[Override]
252		public function getSectorId(): ?int
253		{
254	1	$layer = $this->getLayer();
255	1	if ($layer === null) {
256		throw new RuntimeException('Layer of Map can not be null');
257		}
258
259	1	$cx = $this->getCx();
260	1	$cy = $this->getCy();
261	1	if ($cx === null \|\| $cy === null) {
262		throw new RuntimeException('Cx and Cy of Map can not be null');
263		}
264
265	1	return $layer->getSectorId(
266	1	(int) ceil($cx / MapEnum::FIELDS_PER_SECTION),
267	1	(int) ceil($cy / MapEnum::FIELDS_PER_SECTION)
268	1	);
269		}
270
271	7	#[Override]
272		public function getSectorString(): string
273		{
274	7	return $this->getCx() . '\|' . $this->getCy();
275		}
276		}
277

st-universe / core

Push — dev ( 98511f...00baf5 )

Map::getSectorString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like