FlightRoute::isImpulseDriveNeeded() - Code Metrics - st-universe/core - Measure and Improve Code Quality continuously with Scrutinizer

FlightRoute::isImpulseDriveNeeded() A
last analyzed 2025-08-16 07:53 UTC

↳ Parent: FlightRoute

Complexity

Conditions	4
Paths	3

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
cc	4
eloc	8
nc	3
nop	0
dl	0
loc	14
ccs	0
cts	7
cp	0
crap	20
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Stu\Module\Spacecraft\Lib\Movement\Route;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Override;
filter:
    dependency_paths: ["lib/*"]
use RuntimeException;
use Stu\Component\Map\Effects\EffectHandlingInterface;
use Stu\Lib\Map\FieldTypeEffectEnum;
use Stu\Module\Spacecraft\Lib\Message\MessageCollectionInterface;
use Stu\Module\Spacecraft\Lib\Movement\Component\Consequence\FlightConsequenceInterface;
use Stu\Module\Spacecraft\Lib\Movement\FlightCompany;
use Stu\Module\Spacecraft\Lib\SpacecraftWrapperInterface;
use Stu\Orm\Entity\Location;
use Stu\Orm\Entity\Map;
use Stu\Orm\Entity\Spacecraft;
use Stu\Orm\Entity\StarSystemMap;
use Stu\Orm\Entity\Station;
use Stu\Orm\Entity\WormholeEntry;

final class FlightRoute implements FlightRouteInterface
{
    //Members
    private bool $isTraversing = false;

    private RouteModeEnum $routeMode = RouteModeEnum::FLIGHT;

    private Location $current;

    private ?WormholeEntry $wormholeEntry = null;

    /**
     * @var Collection<int, Location>
     */
    private Collection $waypoints;

    /**
     * @param array<string, FlightConsequenceInterface> $flightConsequences
     * @param array<string, FlightConsequenceInterface> $postFlightConsequences
     */
    public function __construct(
        private CheckDestinationInterface $checkDestination,
        private LoadWaypointsInterface $loadWaypoints,
        private EnterWaypointInterface $enterWaypoint,
        private EffectHandlingInterface $effectHandling,
        private array $flightConsequences,
        private array $postFlightConsequences,
    ) {
        $this->waypoints = new ArrayCollection();
    }

    #[Override]
    public function setDestination(
        Map|StarSystemMap $destination,
        bool $isTranswarp
    ): FlightRouteInterface {
        $this->waypoints->add($destination);

        if ($destination instanceof Map) {
            if ($isTranswarp) {
                $this->routeMode = RouteModeEnum::TRANSWARP;
            } else {
                $this->routeMode = RouteModeEnum::SYSTEM_EXIT;
            }
        } else {
            $this->routeMode = RouteModeEnum::SYSTEM_ENTRY;
        }

        return $this;
    }

    #[Override]
    public function setDestinationViaWormhole(WormholeEntry $wormholeEntry, bool $isEntry): FlightRouteInterface
    {
        $this->wormholeEntry = $wormholeEntry;
        if ($isEntry) {
            $this->waypoints->add($wormholeEntry->getSystemMap());
            $this->routeMode = RouteModeEnum::WORMHOLE_ENTRY;
        } else {
            $this->waypoints->add($wormholeEntry->getMap());
            $this->routeMode = RouteModeEnum::WORMHOLE_EXIT;
        }

        return $this;
    }

    #[Override]
    public function setDestinationViaCoordinates(Spacecraft $spacecraft, int $x, int $y): FlightRouteInterface
    {
        $start = $spacecraft->getLocation();
        $this->current = $start;
        $destination = $this->checkDestination->validate($spacecraft, $x, $y);

        if ($start !== $destination) {
            $this->waypoints = $this->loadWaypoints->load($start, $destination);
            $this->isTraversing = true;
        }

        return $this;
    }

    #[Override]
    public function getCurrentWaypoint(): Location
    {
        return $this->current;
    }

    #[Override]
    public function getNextWaypoint(): Location
    {
        if ($this->waypoints->isEmpty()) {
            throw new RuntimeException('isDestinationArrived has to be called beforehand');
        }

        return $this->waypoints->first();
    }

    private function stepForward(): void
    {
        $first =  $this->waypoints->first();

        if (!$first) {
            return;
        }

        $this->current = $first;
        $this->waypoints->removeElement($this->current);
    }

    #[Override]
    public function abortFlight(): void
    {
        $this->waypoints->clear();
    }

    #[Override]
    public function enterNextWaypoint(
        FlightCompany $flightCompany,
        MessageCollectionInterface $messages
    ): void {

        $wrappers = $flightCompany->getActiveMembers();

        // flight consequences
        $this->walkWrappers(
            $wrappers,
            function (SpacecraftWrapperInterface $wrapper) use ($messages): void {
                $this->walkConsequences($this->flightConsequences, $wrapper, $messages);
            }
        );

        // enter waypoint
        $this->walkWrappers(
            $wrappers,
            function (SpacecraftWrapperInterface $wrapper): void {
                $this->enterWaypoint->enterNextWaypoint(
                    $wrapper->get(),
                    $this->isTraversing,
                    $this->getNextWaypoint(),
                    $this->wormholeEntry
                );
            }
        );

        $this->effectHandling->addFlightInformationForActiveEffects($this->getNextWaypoint(), $messages);

        // post flight consequences
        $this->walkWrappers(
            $wrappers,
            function (SpacecraftWrapperInterface $wrapper) use ($messages): void {
                $this->walkConsequences($this->postFlightConsequences, $wrapper, $messages);
            }
        );

        $this->stepForward();
    }

    /** @param Collection<int, SpacecraftWrapperInterface> $wrappers */
    private function walkWrappers(Collection $wrappers, callable $func): void
    {
        foreach ($wrappers as $wrapper) {
            $func($wrapper);
        }
    }

    /**
     * @param array<string, FlightConsequenceInterface> $consequences
     */
    private function walkConsequences(
        array $consequences,
        ?SpacecraftWrapperInterface $wrapper,
        MessageCollectionInterface $messages
    ): void {

        if ($wrapper === null) {
            return;
        }

        array_walk(
            $consequences,
            fn(FlightConsequenceInterface $consequence) => $consequence->trigger($wrapper, $this, $messages)
        );

        $this->walkConsequences($consequences, $wrapper->getTractoredShipWrapper(), $messages);
    }

    #[Override]
    public function isDestinationArrived(): bool
    {
        return $this->waypoints->isEmpty();
    }

    #[Override]
    public function getRouteMode(): RouteModeEnum
    {
        return $this->routeMode;
    }

    #[Override]
    public function isTraversing(): bool
    {
        return $this->isTraversing;
    }

    #[Override]
    public function isImpulseDriveNeeded(): bool
    {
        $routeMode = $this->routeMode;

        if (
            $routeMode === RouteModeEnum::SYSTEM_ENTRY
            || $routeMode === RouteModeEnum::WORMHOLE_ENTRY
        ) {
            return true;
        }

        return $routeMode === RouteModeEnum::FLIGHT
            && $this->getNextWaypoint() instanceof StarSystemMap;
    }

    #[Override]
    public function isWarpDriveNeeded(): bool
    {
        $routeMode = $this->routeMode;

        if (
            $routeMode === RouteModeEnum::SYSTEM_EXIT
            || $routeMode === RouteModeEnum::TRANSWARP
        ) {
            return true;
        }

        return $routeMode === RouteModeEnum::FLIGHT
            && $this->getNextWaypoint() instanceof Map;
    }

    #[Override]
    public function isTranswarpCoilNeeded(): bool
    {
        return $this->routeMode === RouteModeEnum::TRANSWARP;
    }

    #[Override]
    public function hasSpecialDamageOnField(): bool
    {
        foreach ($this->waypoints as $waypoint) {
            if ($waypoint->getFieldType()->getSpecialDamage() > 0) {
                return true;
            }
        }

        return false;
    }

    #[Override]
    public function hasEffectOnRoute(FieldTypeEffectEnum $effect): bool
    {
        foreach ($this->waypoints as $waypoint) {
            if ($waypoint->getFieldType()->hasEffect($effect)) {
                return true;
            }
        }

        return false;
    }

    #[Override]
    public function isDestinationInAdminRegion(array $regionIds): bool
    {
        $destination = $this->waypoints->last();

        return $destination instanceof Map
            && in_array($destination->getAdminRegionId(), $regionIds);
    }

    #[Override]
    public function isDestinationAtTradepost(): bool
    {
        $destination = $this->waypoints->last();

        return $destination instanceof Map
            && $destination->getSpacecrafts()->exists(fn(int $key, Spacecraft $spacecraft): bool => $spacecraft instanceof Station && $spacecraft->getTradePost() !== null);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Stu\Module\Spacecraft\Lib\Movement\Route;
6
7		use Doctrine\Common\Collections\ArrayCollection;
8		use Doctrine\Common\Collections\Collection;
9		use Override;
		0 ignored issues – show Bug introduced 2024-12-14 23:56 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...
10		use RuntimeException;
11		use Stu\Component\Map\Effects\EffectHandlingInterface;
12		use Stu\Lib\Map\FieldTypeEffectEnum;
13		use Stu\Module\Spacecraft\Lib\Message\MessageCollectionInterface;
14		use Stu\Module\Spacecraft\Lib\Movement\Component\Consequence\FlightConsequenceInterface;
15		use Stu\Module\Spacecraft\Lib\Movement\FlightCompany;
16		use Stu\Module\Spacecraft\Lib\SpacecraftWrapperInterface;
17		use Stu\Orm\Entity\Location;
18		use Stu\Orm\Entity\Map;
19		use Stu\Orm\Entity\Spacecraft;
20		use Stu\Orm\Entity\StarSystemMap;
21		use Stu\Orm\Entity\Station;
22		use Stu\Orm\Entity\WormholeEntry;
23
24		final class FlightRoute implements FlightRouteInterface
25		{
26		//Members
27		private bool $isTraversing = false;
28
29		private RouteModeEnum $routeMode = RouteModeEnum::FLIGHT;
30
31		private Location $current;
32
33		private ?WormholeEntry $wormholeEntry = null;
34
35		/**
36		* @var Collection<int, Location>
37		*/
38		private Collection $waypoints;
39
40		/**
41		* @param array<string, FlightConsequenceInterface> $flightConsequences
42		* @param array<string, FlightConsequenceInterface> $postFlightConsequences
43		*/
44	21	public function __construct(
45		private CheckDestinationInterface $checkDestination,
46		private LoadWaypointsInterface $loadWaypoints,
47		private EnterWaypointInterface $enterWaypoint,
48		private EffectHandlingInterface $effectHandling,
49		private array $flightConsequences,
50		private array $postFlightConsequences,
51		) {
52	21	$this->waypoints = new ArrayCollection();
53		}
54
55	8	#[Override]
56		public function setDestination(
57		Map\|StarSystemMap $destination,
58		bool $isTranswarp
59		): FlightRouteInterface {
60	8	$this->waypoints->add($destination);
61
62	8	if ($destination instanceof Map) {
63	6	if ($isTranswarp) {
64	1	$this->routeMode = RouteModeEnum::TRANSWARP;
65		} else {
66	5	$this->routeMode = RouteModeEnum::SYSTEM_EXIT;
67		}
68		} else {
69	2	$this->routeMode = RouteModeEnum::SYSTEM_ENTRY;
70		}
71
72	8	return $this;
73		}
74
75	2	#[Override]
76		public function setDestinationViaWormhole(WormholeEntry $wormholeEntry, bool $isEntry): FlightRouteInterface
77		{
78	2	$this->wormholeEntry = $wormholeEntry;
79	2	if ($isEntry) {
80	1	$this->waypoints->add($wormholeEntry->getSystemMap());
81	1	$this->routeMode = RouteModeEnum::WORMHOLE_ENTRY;
82		} else {
83	1	$this->waypoints->add($wormholeEntry->getMap());
84	1	$this->routeMode = RouteModeEnum::WORMHOLE_EXIT;
85		}
86
87	2	return $this;
88		}
89
90	8	#[Override]
91		public function setDestinationViaCoordinates(Spacecraft $spacecraft, int $x, int $y): FlightRouteInterface
92		{
93	8	$start = $spacecraft->getLocation();
94	8	$this->current = $start;
95	8	$destination = $this->checkDestination->validate($spacecraft, $x, $y);
96
97	8	if ($start !== $destination) {
98	7	$this->waypoints = $this->loadWaypoints->load($start, $destination);
99	7	$this->isTraversing = true;
100		}
101
102	8	return $this;
103		}
104
105		#[Override]
106		public function getCurrentWaypoint(): Location
107		{
108		return $this->current;
109		}
110
111	8	#[Override]
112		public function getNextWaypoint(): Location
113		{
114	8	if ($this->waypoints->isEmpty()) {
115	1	throw new RuntimeException('isDestinationArrived has to be called beforehand');
116		}
117
118	7	return $this->waypoints->first();
119		}
120
121	6	private function stepForward(): void
122		{
123	6	$first = $this->waypoints->first();
124
125	6	if (!$first) {
126		return;
127		}
128
129	6	$this->current = $first;
130	6	$this->waypoints->removeElement($this->current);
131		}
132
133	1	#[Override]
134		public function abortFlight(): void
135		{
136	1	$this->waypoints->clear();
137		}
138
139	6	#[Override]
140		public function enterNextWaypoint(
141		FlightCompany $flightCompany,
142		MessageCollectionInterface $messages
143		): void {
144
145	6	$wrappers = $flightCompany->getActiveMembers();
146
147		// flight consequences
148	6	$this->walkWrappers(
149	6	$wrappers,
150	6	function (SpacecraftWrapperInterface $wrapper) use ($messages): void {
151	6	$this->walkConsequences($this->flightConsequences, $wrapper, $messages);
152	6	}
153	6	);
154
155		// enter waypoint
156	6	$this->walkWrappers(
157	6	$wrappers,
158	6	function (SpacecraftWrapperInterface $wrapper): void {
159	6	$this->enterWaypoint->enterNextWaypoint(
160	6	$wrapper->get(),
161	6	$this->isTraversing,
162	6	$this->getNextWaypoint(),
163	6	$this->wormholeEntry
164	6	);
165	6	}
166	6	);
167
168	6	$this->effectHandling->addFlightInformationForActiveEffects($this->getNextWaypoint(), $messages);
169
170		// post flight consequences
171	6	$this->walkWrappers(
172	6	$wrappers,
173	6	function (SpacecraftWrapperInterface $wrapper) use ($messages): void {
174	6	$this->walkConsequences($this->postFlightConsequences, $wrapper, $messages);
175	6	}
176	6	);
177
178	6	$this->stepForward();
179		}
180
181		/** @param Collection<int, SpacecraftWrapperInterface> $wrappers */
182	6	private function walkWrappers(Collection $wrappers, callable $func): void
183		{
184	6	foreach ($wrappers as $wrapper) {
185	6	$func($wrapper);
186		}
187		}
188
189		/**
190		* @param array<string, FlightConsequenceInterface> $consequences
191		*/
192	6	private function walkConsequences(
193		array $consequences,
194		?SpacecraftWrapperInterface $wrapper,
195		MessageCollectionInterface $messages
196		): void {
197
198	6	if ($wrapper === null) {
199	6	return;
200		}
201
202	6	array_walk(
203	6	$consequences,
204	6	fn(FlightConsequenceInterface $consequence) => $consequence->trigger($wrapper, $this, $messages)
205	6	);
206
207	6	$this->walkConsequences($consequences, $wrapper->getTractoredShipWrapper(), $messages);
208		}
209
210	8	#[Override]
211		public function isDestinationArrived(): bool
212		{
213	8	return $this->waypoints->isEmpty();
214		}
215
216	6	#[Override]
217		public function getRouteMode(): RouteModeEnum
218		{
219	6	return $this->routeMode;
220		}
221
222		#[Override]
223		public function isTraversing(): bool
224		{
225		return $this->isTraversing;
226		}
227
228		#[Override]
229		public function isImpulseDriveNeeded(): bool
230		{
231		$routeMode = $this->routeMode;
232
233		if (
234		$routeMode === RouteModeEnum::SYSTEM_ENTRY
235		\|\| $routeMode === RouteModeEnum::WORMHOLE_ENTRY
236		) {
237		return true;
238		}
239
240		return $routeMode === RouteModeEnum::FLIGHT
241		&& $this->getNextWaypoint() instanceof StarSystemMap;
242		}
243
244		#[Override]
245		public function isWarpDriveNeeded(): bool
246		{
247		$routeMode = $this->routeMode;
248
249		if (
250		$routeMode === RouteModeEnum::SYSTEM_EXIT
251		\|\| $routeMode === RouteModeEnum::TRANSWARP
252		) {
253		return true;
254		}
255
256		return $routeMode === RouteModeEnum::FLIGHT
257		&& $this->getNextWaypoint() instanceof Map;
258		}
259
260		#[Override]
261		public function isTranswarpCoilNeeded(): bool
262		{
263		return $this->routeMode === RouteModeEnum::TRANSWARP;
264		}
265
266	2	#[Override]
267		public function hasSpecialDamageOnField(): bool
268		{
269	2	foreach ($this->waypoints as $waypoint) {
270	2	if ($waypoint->getFieldType()->getSpecialDamage() > 0) {
271	1	return true;
272		}
273		}
274
275	1	return false;
276		}
277
278	2	#[Override]
279		public function hasEffectOnRoute(FieldTypeEffectEnum $effect): bool
280		{
281	2	foreach ($this->waypoints as $waypoint) {
282	2	if ($waypoint->getFieldType()->hasEffect($effect)) {
283	1	return true;
284		}
285		}
286
287	1	return false;
288		}
289
290	2	#[Override]
291		public function isDestinationInAdminRegion(array $regionIds): bool
292		{
293	2	$destination = $this->waypoints->last();
294
295	2	return $destination instanceof Map
296	2	&& in_array($destination->getAdminRegionId(), $regionIds);
297		}
298
299	4	#[Override]
300		public function isDestinationAtTradepost(): bool
301		{
302	4	$destination = $this->waypoints->last();
303
304	4	return $destination instanceof Map
305	4	&& $destination->getSpacecrafts()->exists(fn(int $key, Spacecraft $spacecraft): bool => $spacecraft instanceof Station && $spacecraft->getTradePost() !== null);
306		}
307		}
308

st-universe / core

FlightRoute::isImpulseDriveNeeded() A last analyzed 2025-08-16 07:53 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

FlightRoute::isImpulseDriveNeeded() A
last analyzed 2025-08-16 07:53 UTC