HeroesofAbenez\Combat\CombatLogEntry

Complexity

Total Complexity

23

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Test Coverage

Coverage

81.69%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getCharacter1()	0	2	1
A	__toString()	0	2	1
A	getName()	0	2	1
A	configureOptions()	0	15	1
A	getAllowedActions()	0	2	1
A	getAmount()	0	2	1
A	getAction()	0	2	1
C	parse()	0	44	12
A	__construct()	0	12	1
A	getMessage()	0	2	1
A	isResult()	0	2	1
A	getCharacter2()	0	2	1

<?php
declare(strict_types=1);

namespace HeroesofAbenez\Combat;

use Nette\Localization\ITranslator;
use Nexendrie\Utils\Constants;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Data structure for combat action
 *
 * @author Jakub Konečný
 * @property-read Character $character1
 * @property-read Character $character2
 * @property-read string $action
 * @property-read string $name
 * @property-read bool $result
 * @property-read int $amount
 * @property-read string $message
 */
class CombatLogEntry {
  use \Nette\SmartObject;
  
  public const ACTION_ATTACK = "attack";
  public const ACTION_SKILL_ATTACK = "skill_attack";
  public const ACTION_SKILL_SPECIAL = "skill_special";
  public const ACTION_HEALING = "healing";
  public const ACTION_POISON = "poison";
  
  /** @var ITranslator */
  protected $translator;
  /** @var Character */
  protected $character1;
  /** @var Character */
  protected $character2;
  /** @var  string */
  protected $action;
  /** @var string */
  protected $name;
  /** @var bool */
  protected $result;
  /** @var int */
  protected $amount;
  /** @var string */
  protected $message;
  
  public function __construct(ITranslator $translator, array $action) {
    $resolver = new OptionsResolver();
    $this->configureOptions($resolver);
    $action = $resolver->resolve($action);
    $this->translator = $translator;
    $this->action = $action["action"];

The property action is declared read-only in HeroesofAbenez\Combat\CombatLogEntry.

    $this->result = $action["result"];

The property result is declared read-only in HeroesofAbenez\Combat\CombatLogEntry.

    $this->amount = $action["amount"];

The property amount is declared read-only in HeroesofAbenez\Combat\CombatLogEntry.

    $this->character1 = $action["character1"];

The property character1 is declared read-only in HeroesofAbenez\Combat\CombatLogEntry.

    $this->character2 = $action["character2"];

The property character2 is declared read-only in HeroesofAbenez\Combat\CombatLogEntry.

    $this->name = $action["name"];

The property name is declared read-only in HeroesofAbenez\Combat\CombatLogEntry.

    $this->parse();
  }

  protected function configureOptions(OptionsResolver $resolver): void {
    $requiredStats = ["action", "result", "character1", "character2",];
    $resolver->setDefined(["amount", "name",]);
    $resolver->setRequired($requiredStats);
    $resolver->setAllowedTypes("action", "string");
    $resolver->setAllowedValues("action", function(string $value) {
      return in_array($value, $this->getAllowedActions(), true);
    });
    $resolver->setAllowedTypes("result", "bool");
    $resolver->setAllowedTypes("amount", "integer");
    $resolver->setDefault("amount", 0);
    $resolver->setAllowedTypes("name", "string");
    $resolver->setDefault("name", "");
    $resolver->setAllowedTypes("character1", Character::class);
    $resolver->setAllowedTypes("character2", Character::class);
  }

  /**
   * @return string[]
   */
  protected function getAllowedActions(): array {
    return Constants::getConstantsValues(static::class, "ACTION_");
  }
  
  public function getCharacter1(): Character {
    return $this->character1;
  }
  
  public function getCharacter2(): Character {
    return $this->character2;
  }
  
  public function getAction(): string {
    return $this->action;
  }
  
  public function getName(): string {
    return $this->name;
  }
  
  public function isResult(): bool {
    return $this->result;
  }
  
  public function getAmount(): int {
    return $this->amount;
  }
  
  public function getMessage(): string {
    return $this->message;
  }
  
  protected function parse(): void {

Function's cyclomatic complexity (12) exceeds 10; consider refactoring the function

    $character1 = $this->character1->name;
    $character2 = $this->character2->name;
    $text = "";
    switch($this->action) {
      case static::ACTION_ATTACK:
        if($this->result) {
          $text = $this->translator->translate("combat.log.attackHits", $this->amount, ["character1" => $character1, "character2" => $character2]);

Line exceeds 120 characters; contains 147 characters

          if($this->character2->hitpoints < 1) {
            $text .= $this->translator->translate("combat.log.characterFalls");
          }
        } else {
          $text = $this->translator->translate("combat.log.attackFails", $this->amount, ["character1" => $character1, "character2" => $character2]);

Line exceeds 120 characters; contains 148 characters

        }
        break;
      case static::ACTION_SKILL_ATTACK:
        if($this->result) {
          $text = $this->translator->translate("combat.log.specialAttackHits", $this->amount, ["character1" => $character1, "character2" => $character2, "name" => $this->name]);

Line exceeds 120 characters; contains 177 characters

          if($this->character2->hitpoints < 1) {
            $text .= $this->translator->translate("combat.log.characterFalls");
          }
        } else {
          $text = $this->translator->translate("combat.log.specialAttackFails", $this->amount, ["character1" => $character1, "character2" => $character2, "name" => $this->name]);

Line exceeds 120 characters; contains 178 characters

        }
        break;
      case static::ACTION_SKILL_SPECIAL:
        if($this->result) {
          $text = $this->translator->translate("combat.log.specialSkillSuccess", 0, ["character1" => $character1, "character2" => $character2, "name" => $this->name]);

Line exceeds 120 characters; contains 167 characters

        } else {
          $text = $this->translator->translate("combat.log.specialSKillFailure", 0, ["character1" => $character1, "character2" => $character2, "name" => $this->name]);

Line exceeds 120 characters; contains 167 characters

        }
        break;
      case static::ACTION_HEALING:
        if($this->result) {
          $text = $this->translator->translate("combat.log.healingSuccess", $this->amount, ["character1" => $character1, "character2" => $character2]);

Line exceeds 120 characters; contains 151 characters

        } else {
          $text = $this->translator->translate("combat.log.healingFailure", $this->amount, ["character1" => $character1, "character2" => $character2]);

Line exceeds 120 characters; contains 151 characters

        }
        break;
      case static::ACTION_POISON:
        $text = $this->translator->translate("combat.log.poison", $this->amount, ["character1" => $character1]);
        break;
    }
    $this->message =  $text;

The property message is declared read-only in HeroesofAbenez\Combat\CombatLogEntry.

  }
  
  public function __toString(): string {
    return $this->message;
  }
}
?>