jaroslavtyc/drd-plus-therugist-spells

File `Modifier.php` has 375 lines of code (exceeds 250 allowed). Consider refactoring.
<?php
declare(strict_types=1);
 
namespace DrdPlus\Theurgist\Spells;
 
use DrdPlus\Codes\Theurgist\ModifierCode;
use DrdPlus\Codes\Theurgist\ModifierMutableSpellParameterCode;
use DrdPlus\Theurgist\Spells\SpellParameters\Attack;
use DrdPlus\Theurgist\Spells\SpellParameters\CastingRounds;
use DrdPlus\Theurgist\Spells\SpellParameters\Noise;
use DrdPlus\Theurgist\Spells\SpellParameters\NumberOfConditions;
use DrdPlus\Theurgist\Spells\SpellParameters\DifficultyChange;
use DrdPlus\Theurgist\Spells\SpellParameters\EpicenterShift;
use DrdPlus\Theurgist\Spells\SpellParameters\Grafts;
use DrdPlus\Theurgist\Spells\SpellParameters\Invisibility;
use DrdPlus\Theurgist\Spells\SpellParameters\NumberOfSituations;
use DrdPlus\Theurgist\Spells\SpellParameters\Partials\CastingParameter;
use DrdPlus\Theurgist\Spells\SpellParameters\NumberOfWaypoints;
use DrdPlus\Theurgist\Spells\SpellParameters\Power;
use DrdPlus\Theurgist\Spells\SpellParameters\Quality;
use DrdPlus\Theurgist\Spells\SpellParameters\Radius;
use DrdPlus\Theurgist\Spells\SpellParameters\Realm;
use DrdPlus\Theurgist\Spells\SpellParameters\RealmsAffection;
use DrdPlus\Theurgist\Spells\SpellParameters\Resistance;
use DrdPlus\Theurgist\Spells\SpellParameters\SpellSpeed;
use DrdPlus\Theurgist\Spells\SpellParameters\Threshold;
use Granam\Integer\Tools\ToInteger;
use Granam\Strict\Object\StrictObject;
use Granam\String\StringTools;
use Granam\Tools\ValueDescriber;
 
`Modifier` has 51 functions (exceeds 20 allowed). Consider refactoring.
The class Modifier has an overall complexity of 74 which is very high. The configured complexity threshold is 50.
The class Modifier has 49 public methods and attributes. Consider reducing the number of public items to less than 45.
The class Modifier has a coupling between objects value of 33. Consider to reduce the number of dependencies under 13.
class Modifier extends StrictObject
{
    use ToFlatArrayTrait;
 
    /** @var ModifierCode */
    private $modifierCode;
    /** @var ModifiersTable */
    private $modifiersTable;
    /** @var array|int[] */
Avoid excessively long variable names like $modifierSpellParameterChanges. Keep variable name length under 20.
    private $modifierSpellParameterChanges;
    /** @var array|SpellTrait[] */
    private $modifierSpellTraits;
 
    /**
     * @param ModifierCode $modifierCode
     * @param ModifiersTable $modifiersTable
     * @param array|int[] $modifierSpellParameterValues spell parameters current values (delta will be calculated from them)
     * by @see ModifierMutableSpellParameterCode value indexed its value change
     * @param array|SpellTrait[] $modifierSpellTraits
     * @throws \DrdPlus\Theurgist\Spells\Exceptions\UselessValueForUnusedSpellParameter
     * @throws \DrdPlus\Theurgist\Spells\Exceptions\UnknownModifierParameter
     * @throws \DrdPlus\Theurgist\Spells\Exceptions\InvalidValueForModifierParameter
     * @throws \DrdPlus\Theurgist\Spells\Exceptions\InvalidSpellTrait
     */
    public function __construct(
        ModifierCode $modifierCode,
        ModifiersTable $modifiersTable,
Avoid excessively long variable names like $modifierSpellParameterValues. Keep variable name length under 20.
        array $modifierSpellParameterValues,
        array $modifierSpellTraits
    )
    {
        $this->modifierCode = $modifierCode;
        $this->modifiersTable = $modifiersTable;
        $this->modifierSpellParameterChanges = $this->sanitizeSpellParameterChanges($modifierSpellParameterValues);
        $this->modifierSpellTraits = $this->getCheckedSpellTraits($this->toFlatArray($modifierSpellTraits));
    }
 
    /**
     * @param array $spellParameterValues
     * @return array
     * @throws \DrdPlus\Theurgist\Spells\Exceptions\UselessValueForUnusedSpellParameter
     * @throws \DrdPlus\Theurgist\Spells\Exceptions\InvalidValueForModifierParameter
     * @throws \DrdPlus\Theurgist\Spells\Exceptions\UnknownModifierParameter
     */
Method `sanitizeSpellParameterChanges` has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Function `sanitizeSpellParameterChanges` has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    private function sanitizeSpellParameterChanges(array $spellParameterValues): array
    {
        $sanitizedChanges = [];
Avoid using static access to class '\DrdPlus\Codes\Theurgist\ModifierMutableSpellParameterCode' in method 'sanitizeSpellParameterChanges'.
Avoid excessively long variable names like $mutableSpellParameter. Keep variable name length under 20.
        foreach (ModifierMutableSpellParameterCode::getPossibleValues() as $mutableSpellParameter) {
            if (!array_key_exists($mutableSpellParameter, $spellParameterValues)) {
                $sanitizedChanges[$mutableSpellParameter] = 0; // no change
                continue;
            }
            try {
Avoid using static access to class '\Granam\Integer\Tools\ToInteger' in method 'sanitizeSpellParameterChanges'.
                $sanitizedValue = ToInteger::toInteger($spellParameterValues[$mutableSpellParameter]);
            } catch (\Granam\Integer\Tools\Exceptions\Exception $exception) {
                throw new Exceptions\InvalidValueForModifierParameter(
Avoid using static access to class '\Granam\Tools\ValueDescriber' in method 'sanitizeSpellParameterChanges'.
                    'Expected integer, got ' . ValueDescriber::describe($spellParameterValues[$mutableSpellParameter])
                    . ' for ' . $mutableSpellParameter . ": '{$exception->getMessage()}'"
                );
            }
            /** like @see getBaseAttack */
Avoid using static access to class '\Granam\String\StringTools' in method 'sanitizeSpellParameterChanges'.
            $getBaseParameter = StringTools::assembleGetterForName('base_' . $mutableSpellParameter);
            /** @var CastingParameter $baseParameter */
            $baseParameter = $this->$getBaseParameter();
            if ($baseParameter === null) {
                throw new Exceptions\UselessValueForUnusedSpellParameter(
                    "Casting parameter {$mutableSpellParameter} is not used for modifier {$this->modifierCode}"
Avoid using static access to class '\Granam\Tools\ValueDescriber' in method 'sanitizeSpellParameterChanges'.
                    . ', so given spell parameter value ' . ValueDescriber::describe($spellParameterValues[$mutableSpellParameter])
                    . ' is thrown away'
                );
            }
            $parameterChange = $sanitizedValue - $baseParameter->getDefaultValue();
            $sanitizedChanges[$mutableSpellParameter] = $parameterChange;
 
            unset($spellParameterValues[$mutableSpellParameter]);
        }
        if (\count($spellParameterValues) > 0) { // there are some remains
            throw new Exceptions\UnknownModifierParameter(
                'Unexpected mutable spell parameter(s) [' . implode(', ', array_keys($spellParameterValues)) . ']. Expected only '
Avoid using static access to class '\DrdPlus\Codes\Theurgist\ModifierMutableSpellParameterCode' in method 'sanitizeSpellParameterChanges'.
                . implode(', ', ModifierMutableSpellParameterCode::getPossibleValues())
            );
        }
 
        return $sanitizedChanges;
    }
 
    /**
     * @param array $spellTraits
     * @return array|SpellTrait[]
     * @throws \DrdPlus\Theurgist\Spells\Exceptions\InvalidSpellTrait
     */
    private function getCheckedSpellTraits(array $spellTraits): array
    {
        foreach ($spellTraits as $spellTrait) {
            if (!is_a($spellTrait, SpellTrait::class)) {
                throw new Exceptions\InvalidSpellTrait(
Avoid using static access to class '\Granam\Tools\ValueDescriber' in method 'getCheckedSpellTraits'.
                    'Expected instance of ' . static::class . ', got ' . ValueDescriber::describe($spellTrait)
                );
            }
        }
 
        return $spellTraits;
    }
 
    /**
     * @return ModifierCode
     */
    public function getModifierCode(): ModifierCode
    {
        return $this->modifierCode;
    }
 
Method `getDifficultyChange` has 32 lines of code (exceeds 25 allowed). Consider refactoring.
    public function getDifficultyChange(): DifficultyChange
    {
        $modifierParameters = [
            $this->getAttackWithAddition(),
            $this->getNumberOfConditionsWithAddition(),
            $this->getEpicenterShiftWithAddition(),
            $this->getGraftsWithAddition(),
            $this->getInvisibilityWithAddition(),
            $this->getNumberOfSituationsWithAddition(),
            $this->getNumberOfWaypointsWithAddition(),
            $this->getPowerWithAddition(),
            $this->getNoiseWithAddition(),
            $this->getQualityWithAddition(),
            $this->getRadiusWithAddition(),
            $this->getResistanceWithAddition(),
            $this->getSpellSpeedWithAddition(),
            $this->getThresholdWithAddition(),
        ];
        $modifierParameters = array_filter(
            $modifierParameters,
            function (CastingParameter $modifierParameter = null) {
                return $modifierParameter !== null;
            }
        );
Avoid excessively long variable names like $parametersDifficultyChangeSum. Keep variable name length under 20.
        $parametersDifficultyChangeSum = 0;
        /** @var CastingParameter $parameter */
        foreach ($modifierParameters as $parameter) {
            $parametersDifficultyChangeSum += $parameter->getAdditionByDifficulty()->getCurrentDifficultyIncrement();
        }
Avoid excessively long variable names like $spellTraitsDifficultyChangeSum. Keep variable name length under 20.
        $spellTraitsDifficultyChangeSum = 0;
        foreach ($this->modifierSpellTraits as $spellTrait) {
            $spellTraitsDifficultyChangeSum += $spellTrait->getDifficultyChange()->getValue();
        }
        $difficultyChange = $this->modifiersTable->getDifficultyChange($this->getModifierCode());
 
        return $difficultyChange->add($parametersDifficultyChangeSum + $spellTraitsDifficultyChangeSum);
    }
 
    /**
     * @return CastingRounds
     */
    public function getCastingRounds(): CastingRounds
    {
        return $this->modifiersTable->getCastingRounds($this->getModifierCode());
    }
 
    /**
     * @return Realm
     */
    public function getRequiredRealm(): Realm
    {
        return $this->modifiersTable->getRealm($this->getModifierCode());
    }
 
    /**
     * @return RealmsAffection|null
     */
    public function getRealmsAffection(): ?RealmsAffection
    {
        return $this->modifiersTable->getRealmsAffection($this->getModifierCode());
    }
 
    /**
     * @return Radius|null
     */
    public function getBaseRadius(): ?Radius
    {
        return $this->modifiersTable->getRadius($this->modifierCode);
    }
 
    /**
     * @return Radius|null
     */
    public function getRadiusWithAddition(): ?Radius
    {
        $baseRadius = $this->getBaseRadius();
        if ($baseRadius === null) {
            return null;
        }
 
        return $baseRadius->getWithAddition($this->getRadiusAddition());
    }
 
    public function getRadiusAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::RADIUS];
    }
 
    /**
     * @return EpicenterShift|null
     */
    public function getBaseEpicenterShift(): ?EpicenterShift
    {
        return $this->modifiersTable->getEpicenterShift($this->modifierCode);
    }
 
    /**
     * @return EpicenterShift|null
     */
    public function getEpicenterShiftWithAddition(): ?EpicenterShift
    {
        $baseEpicenterShift = $this->getBaseEpicenterShift();
        if ($baseEpicenterShift === null) {
            return null;
        }
 
        return $baseEpicenterShift->getWithAddition($this->getEpicenterShiftAddition());
    }
 
    public function getEpicenterShiftAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::EPICENTER_SHIFT];
    }
 
    /**
     * @return Power|null
     */
    public function getBasePower(): ?Power
    {
        return $this->modifiersTable->getPower($this->modifierCode);
    }
 
    /**
     * @return Power|null
     */
    public function getPowerWithAddition(): ?Power
    {
        $basePower = $this->getBasePower();
        if ($basePower === null) {
            return null;
        }
 
        return $basePower->getWithAddition($this->getPowerAddition());
    }
 
    public function getPowerAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::POWER];
    }
 
    /**
     * @return Noise|null
     */
    public function getBaseNoise(): ?Noise
    {
        return $this->modifiersTable->getNoise($this->modifierCode);
    }
 
    /**
     * @return Noise|null
     */
    public function getNoiseWithAddition(): ?Noise
    {
        $baseNoise = $this->getBaseNoise();
        if ($baseNoise === null) {
            return null;
        }
 
        return $baseNoise->getWithAddition($this->getNoiseAddition());
    }
 
    public function getNoiseAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::NOISE];
    }
 
    /**
     * @return Attack|null
     */
    public function getBaseAttack(): ?Attack
    {
        return $this->modifiersTable->getAttack($this->modifierCode);
    }
 
    /**
     * @return Attack|null
     */
    public function getAttackWithAddition(): ?Attack
    {
        $baseAttack = $this->getBaseAttack();
        if ($baseAttack === null) {
            return null;
        }
 
        return $baseAttack->getWithAddition($this->getAttackAddition());
    }
 
    public function getAttackAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::ATTACK];
    }
 
    /**
     * @return Grafts|null
     */
    public function getBaseGrafts(): ?Grafts
    {
        return $this->modifiersTable->getGrafts($this->modifierCode);
    }
 
    /**
     * @return Grafts|null
     */
    public function getGraftsWithAddition(): ?Grafts
    {
        $baseGrafts = $this->getBaseGrafts();
        if ($baseGrafts === null) {
            return null;
        }
 
        return $baseGrafts->getWithAddition($this->getGraftsAddition());
    }
 
    public function getGraftsAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::GRAFTS];
    }
 
    /**
     * @return SpellSpeed|null
     */
    public function getBaseSpellSpeed(): ?SpellSpeed
    {
        return $this->modifiersTable->getSpellSpeed($this->modifierCode);
    }
 
    /**
     * @return SpellSpeed|null
     */
    public function getSpellSpeedWithAddition(): ?SpellSpeed
    {
        $baseSpellSpeed = $this->getBaseSpellSpeed();
        if ($baseSpellSpeed === null) {
            return null;
        }
 
        return $baseSpellSpeed->getWithAddition($this->getSpellSpeedAddition());
    }
 
    public function getSpellSpeedAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::SPELL_SPEED];
    }
 
    /**
     * @return Invisibility|null
     */
    public function getBaseInvisibility(): ?Invisibility
    {
        return $this->modifiersTable->getInvisibility($this->modifierCode);
    }
 
    /**
     * @return Invisibility|null
     */
    public function getInvisibilityWithAddition(): ?Invisibility
    {
        $baseInvisibility = $this->getBaseInvisibility();
        if ($baseInvisibility === null) {
            return null;
        }
 
        return $baseInvisibility->getWithAddition($this->getInvisibilityAddition());
    }
 
    public function getInvisibilityAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::INVISIBILITY];
    }
 
    /**
     * @return Quality|null
     */
    public function getBaseQuality(): ?Quality
    {
        return $this->modifiersTable->getQuality($this->modifierCode);
    }
 
    /**
     * @return Quality|null
     */
    public function getQualityWithAddition(): ?Quality
    {
        $baseQuality = $this->getBaseQuality();
        if ($baseQuality === null) {
            return null;
        }
 
        return $baseQuality->getWithAddition($this->getQualityAddition());
    }
 
    public function getQualityAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::QUALITY];
    }
 
    /**
     * @return NumberOfConditions|null
     */
    public function getBaseNumberOfConditions(): ?NumberOfConditions
    {
        return $this->modifiersTable->getNumberOfConditions($this->modifierCode);
    }
 
    /**
     * @return NumberOfConditions|null
     */
    public function getNumberOfConditionsWithAddition(): ?NumberOfConditions
    {
        $baseConditions = $this->getBaseNumberOfConditions();
        if ($baseConditions === null) {
            return null;
        }
 
        return $baseConditions->getWithAddition($this->getNumberOfConditionsAddition());
    }
 
    public function getNumberOfConditionsAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::NUMBER_OF_CONDITIONS];
    }
 
    /**
     * @return Resistance|null
     */
    public function getBaseResistance(): ?Resistance
    {
        return $this->modifiersTable->getResistance($this->modifierCode);
    }
 
    /**
     * @return Resistance|null
     */
    public function getResistanceWithAddition(): ?Resistance
    {
        $baseResistance = $this->getBaseResistance();
        if ($baseResistance === null) {
            return null;
        }
 
        return $baseResistance->getWithAddition($this->getResistanceAddition());
    }
 
    public function getResistanceAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::RESISTANCE];
    }
 
    /**
     * @return NumberOfSituations|null
     */
    public function getBaseNumberOfSituations(): ?NumberOfSituations
    {
        return $this->modifiersTable->getNumberOfSituations($this->modifierCode);
    }
 
    /**
     * @return NumberOfSituations|null
     */
    public function getNumberOfSituationsWithAddition(): ?NumberOfSituations
    {
Avoid excessively long variable names like $baseNumberOfSituations. Keep variable name length under 20.
        $baseNumberOfSituations = $this->getBaseNumberOfSituations();
        if ($baseNumberOfSituations === null) {
            return null;
        }
 
        return $baseNumberOfSituations->getWithAddition($this->getNumberOfSituationsAddition());
    }
 
    public function getNumberOfSituationsAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::NUMBER_OF_SITUATIONS];
    }
 
    /**
     * @return Threshold|null
     */
    public function getBaseThreshold(): ?Threshold
    {
        return $this->modifiersTable->getThreshold($this->modifierCode);
    }
 
    /**
     * @return Threshold|null
     */
    public function getThresholdWithAddition(): ?Threshold
    {
        $baseThreshold = $this->getBaseThreshold();
        if ($baseThreshold === null) {
            return null;
        }
 
        return $baseThreshold->getWithAddition($this->getThresholdAddition());
    }
 
    public function getThresholdAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::THRESHOLD];
    }
 
    /**
     * @return NumberOfWaypoints|null
     */
    public function getBaseNumberOfWaypoints(): ?NumberOfWaypoints
    {
        return $this->modifiersTable->getNumberOfWaypoints($this->modifierCode);
    }
 
    /**
     * @return NumberOfWaypoints|null
     */
    public function getNumberOfWaypointsWithAddition(): ?NumberOfWaypoints
    {
Avoid excessively long variable names like $baseNumberOfWaypoints. Keep variable name length under 20.
        $baseNumberOfWaypoints = $this->getBaseNumberOfWaypoints();
        if ($baseNumberOfWaypoints === null) {
            return null;
        }
 
        return $baseNumberOfWaypoints->getWithAddition($this->getNumberOfWaypointsAddition());
    }
 
    public function getNumberOfWaypointsAddition(): int
    {
        return $this->modifierSpellParameterChanges[ModifierMutableSpellParameterCode::NUMBER_OF_WAYPOINTS];
    }
 
    public function __toString()
    {
        return $this->getModifierCode()->getValue();
    }
}