Module::getCostSorted() - Code Metrics - Inspection of "fix" - st-universe/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — dev ( 36270f...5b972f )

by Janko
created 2023-09-19 14:17 UTC
Module::getCostSorted() A

↳ Parent: Module
Complexity

Conditions	1
Paths	1
Size

Total Lines	10
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	5
nc	1
nop	0
dl	0
loc	10
ccs	0
cts	7
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\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\OrderBy;
use Doctrine\ORM\Mapping\Table;
use Stu\Module\ShipModule\ModuleTypeDescriptionMapper;

/**
 * @Entity(repositoryClass="Stu\Orm\Repository\ModuleRepository")
 * @Table(
 *     name="stu_modules",
 *     indexes={
 *         @Index(name="ship_rump_role_type_idx", columns={"rumps_role_id", "type"})
 *     }
 * )
 **/
class Module implements ModuleInterface
{
    /**
     * @Id
     * @Column(type="integer")
     * @GeneratedValue(strategy="IDENTITY")
     *
     */
    private int $id;

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

    /**
     * @Column(type="smallint")
     *
     */
    private int $level = 0;

    /**
     * @Column(type="smallint")
     *
     */
    private int $upgrade_factor = 0;

    /**
     * @Column(type="smallint")
     *
     */
    private int $default_factor = 0;

    /**
     * @Column(type="smallint")
     *
     */
    private int $downgrade_factor = 0;

    /**
     * @Column(type="smallint")
     *
     */
    private int $crew = 0;

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

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

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

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

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

    /**
     * @Column(type="smallint")
     *
     */
    private int $ecost = 0;

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

    /**
     * @var ResearchInterface
     *
     * @ManyToOne(targetEntity="Research")
     * @JoinColumn(name="research_id", referencedColumnName="id")
     */
    private $research;


    /**
     *
     * @ManyToOne(targetEntity="Commodity")
     * @JoinColumn(name="commodity_id", referencedColumnName="id", onDelete="CASCADE")
     */
    private CommodityInterface $commodity;

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

    /**
     * @var ShipRumpRoleInterface
     *
     * @ManyToOne(targetEntity="ShipRumpRole")
     * @JoinColumn(name="rumps_role_id", referencedColumnName="id")
     */
    private $shipRumpRole;


    /**
     * @var ArrayCollection<int, ModuleSpecialInterface>
     *
     * @OneToMany(targetEntity="ModuleSpecial", mappedBy="module")
     * @OrderBy({"special_id": "ASC"})
     */
    private Collection $moduleSpecials;

    /**
     * @var ArrayCollection<int, ModuleCostInterface>
     *
     * @OneToMany(targetEntity="ModuleCost", mappedBy="module")
     */
    private Collection $buildingCosts;

    /**
     * @var ArrayCollection<int, TorpedoHullInterface>
     *
     * @OneToMany(targetEntity="TorpedoHull", mappedBy="module", indexBy="torpedo_type")
     * @OrderBy({"torpedo_type": "ASC"})
     */
    private Collection $torpedoHull;

    /**
     * @var ArrayCollection<int, WeaponShieldInterface>
     *
     * @OneToMany(targetEntity="WeaponShield", mappedBy="module", indexBy="weapon_id")
     * @OrderBy({"weapon_id": "ASC"})
     */
    private Collection $weaponShield;

    /**
     * @OneToOne(targetEntity="Weapon", mappedBy="module")
     */
    private ?WeaponInterface $weapon = null;

    /** @var null|array<int> */
    private ?array $specialAbilities = null;

    public function __construct()
    {
        $this->moduleSpecials = new ArrayCollection();
        $this->buildingCosts = new ArrayCollection();
        $this->torpedoHull = new ArrayCollection();
        $this->weaponShield = new ArrayCollection();
    }

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

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

    public function setName(string $name): ModuleInterface
    {
        $this->name = $name;

        return $this;
    }

    public function getLevel(): int
    {
        return $this->level;
    }

    public function setLevel(int $level): ModuleInterface
    {
        $this->level = $level;

        return $this;
    }

    public function getUpgradeFactor(): int
    {
        return $this->upgrade_factor;
    }

    public function setUpgradeFactor(int $upgradeFactor): ModuleInterface
    {
        $this->upgrade_factor = $upgradeFactor;

        return $this;
    }

    public function getDefaultFactor(): int
    {
        return $this->default_factor;
    }

    public function setDefaultFactor(int $defaultFactor): ModuleInterface
    {
        $this->default_factor = $defaultFactor;

        return $this;
    }

    public function getDowngradeFactor(): int
    {
        return $this->downgrade_factor;
    }

    public function setDowngradeFactor(int $downgradeFactor): ModuleInterface
    {
        $this->downgrade_factor = $downgradeFactor;

        return $this;
    }

    public function getCrew(): int
    {
        return $this->crew;
    }

    public function getCrewByFactionAndRumpLvl(?int $factionId, int $rumpModuleLvl = null): int
    {
        $result = $this->getCrew();

        if (
            $this->getFactionId() !== null
            && $this->getFactionId() !== $factionId
        ) {
            $result += 1;
        }

        if (
            $rumpModuleLvl !== null
            && $this->getLevel() > $rumpModuleLvl
        ) {
            $result += 1;
        }

        return $result;
    }

    public function setCrew(int $crew): ModuleInterface
    {
        $this->crew = $crew;

        return $this;
    }

    public function getType(): int
    {
        return $this->type;
    }

    public function setType(int $type): ModuleInterface
    {
        $this->type = $type;

        return $this;
    }

    public function getResearchId(): int
    {
        return $this->research_id;

    }

    public function setResearchId(int $researchId): ModuleInterface
    {
        $this->research_id = $researchId;

        return $this;
    }

    public function getCommodityId(): int
    {
        return $this->commodity_id;
    }

    public function setCommodityId(int $commodityId): ModuleInterface
    {
        $this->commodity_id = $commodityId;

        return $this;
    }

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

    public function setViewable(bool $viewable): ModuleInterface
    {
        $this->viewable = $viewable;

        return $this;
    }

    public function getShipRumpRoleId(): int
    {
        return $this->rumps_role_id;

    }

    public function setShipRumpRoleId(int $shipRumpRoleId): ModuleInterface
    {
        $this->rumps_role_id = $shipRumpRoleId;

        return $this;
    }

    public function getWeapon(): ?WeaponInterface
    {
        return $this->weapon;
    }

    public function getEcost(): int
    {
        return $this->ecost;
    }

    public function setEcost(int $energyCosts): ModuleInterface
    {
        $this->ecost = $energyCosts;

        return $this;
    }

    public function getFactionId(): ?int
    {
        return $this->faction_id;
    }

    public function setFactionId(int $factionId): ?ModuleInterface
    {
        $this->faction_id = $factionId;

        return $this;
    }

    public function hasSpecial($special_id): bool
    {
        if ($this->specialAbilities === null) {
            $this->specialAbilities = array_map(
                fn (ModuleSpecialInterface $moduleSpecial): int => $moduleSpecial->getSpecialId(),
                $this->getSpecials()->toArray()
            );
        }
        return in_array((int)$special_id, $this->specialAbilities);
        return in_array((int)$special_id, /** @scrutinizer ignore-type */ $this->specialAbilities);
    }

    public function getSpecials(): Collection
    {
        return $this->moduleSpecials;
    }

    public function getCost(): Collection
    {
        return $this->buildingCosts;
    }

    public function getCostSorted(): array
    {
        $array = $this->getCost()->getValues();

        usort(
            $array,
            fn (ModuleCostInterface $a, ModuleCostInterface $b): int => $a->getCommodity()->getSort() <=> $b->getCommodity()->getSort()
        );

        return array_values($array);
    }

    public function getCommodity(): CommodityInterface
    {
        return $this->commodity;
    }

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

    public function getTorpedoHull(): Collection
    {
        return $this->torpedoHull;
    }

    public function getWeaponShield(): Collection
    {
        return $this->weaponShield;
    }

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

st-universe / core

Push — dev ( 36270f...5b972f )

Module::getCostSorted() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
