Tfboe\FmLib\Entity\Traits\RankingSystem

Complexity

Total Complexity

14

Size/Duplication

Total Lines	182
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getDefaultForLevel()	0	4	1
A	getGenerationInterval()	0	4	1
A	getHierarchyEntries()	0	4	1
A	getLists()	0	4	1
A	getOpenSyncFrom()	0	4	1
A	getOpenSyncFromInProcess()	0	4	1
A	getServiceName()	0	4	1
A	setDefaultForLevel()	0	7	2
A	setGenerationInterval()	0	5	1
A	setOpenSyncFrom()	0	4	1
A	setOpenSyncFromInProcess()	0	5	1
A	setServiceName()	0	4	1
A	init()	0	9	1

<?php
declare(strict_types=1);
/**
 * Created by PhpStorm.
 * User: benedikt
 * Date: 1/2/18
 * Time: 8:47 PM
 */

namespace Tfboe\FmLib\Entity\Traits;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Tfboe\FmLib\Entity\Helpers\AutomaticInstanceGeneration;
use Tfboe\FmLib\Entity\Helpers\NameEntity;
use Tfboe\FmLib\Entity\Helpers\SubClassData;
use Tfboe\FmLib\Entity\Helpers\TimestampableEntity;
use Tfboe\FmLib\Entity\Helpers\UUIDEntity;
use Tfboe\FmLib\Entity\RankingSystemListInterface;
use Tfboe\FmLib\Entity\TournamentInterface;
use Tfboe\FmLib\Exceptions\ValueNotValid;
use Tfboe\FmLib\Helpers\Level;

/**
 * Trait RankingSystem
 * @package Tfboe\FmLib\Entity\Traits
 */
trait RankingSystem
{
  use SubClassData;
  use TimestampableEntity;
  use UUIDEntity;
  use NameEntity;

  //<editor-fold desc="Fields">

  /**
   * @ORM\Column(type="string")
   *
   * @var string
   */
  private $serviceName;
  /**
   * @ORM\Column(type="smallint", nullable=true)
   * @var int|null
   */
  private $defaultForLevel;

  /**
   * @ORM\Column(type="integer")
   * @var int
   */
  private $generationInterval;

  /**
   * @ORM\ManyToMany(
   *     targetEntity="\Tfboe\FmLib\Entity\Helpers\TournamentHierarchyEntity",
   *     mappedBy="rankingSystems",
   *     indexBy="id"
   * )
   * @ORM\JoinTable(name="relation__tournament_ranking_systems")
   * @var Collection|TournamentInterface[]
   */
  private $hierarchyEntries;
  /**
   * @ORM\Column(type="datetime", nullable=true)
   * @var \DateTime|null
   */
  private $openSyncFrom;

  /**
   * @ORM\Column(type="datetime", nullable=true)
   * @var \DateTime|null
   */
  private $openSyncFromInProcess;

  /**
   * @ORM\OneToMany(targetEntity="\Tfboe\FmLib\Entity\RankingSystemListInterface", mappedBy="rankingSystem",
   *   indexBy="id")
   * @var Collection|RankingSystemListInterface[]
   */
  private $lists;
//</editor-fold desc="Fields">

//<editor-fold desc="Constructor">
//</editor-fold desc="Constructor">

//<editor-fold desc="Public Methods">
  /**
   * @return int|null
   */
  public function getDefaultForLevel(): ?int
  {
    return $this->defaultForLevel;
  }

  /**
   * @return int
   */
  public function getGenerationInterval(): int
  {
    return $this->generationInterval;
  }

  /**
   * @return TournamentInterface[]|Collection
   */
  public function getHierarchyEntries()
  {
    return $this->hierarchyEntries;
  }

  /**
   * @return RankingSystemListInterface[]|Collection
   */
  public function getLists(): Collection
  {
    return $this->lists;
  }

  /**
   * @return \DateTime|null
   */
  public function getOpenSyncFrom(): ?\DateTime
  {
    return $this->openSyncFrom;
  }

  /**
   * @return \DateTime|null
   */
  public function getOpenSyncFromInProcess(): ?\DateTime
  {
    return $this->openSyncFromInProcess;
  }

  /**
   * @return string
   */
  public function getServiceName(): string
  {
    return $this->serviceName;
  }

  /**
   * @param int|null $defaultForLevel
   * @throws ValueNotValid
   */
  public function setDefaultForLevel(?int $defaultForLevel)
  {
    if ($defaultForLevel !== null) {
      Level::ensureValidValue($defaultForLevel);
    }
    $this->defaultForLevel = $defaultForLevel;
  }

  /**
   * @param int $generationInterval
   * @throws \Tfboe\FmLib\Exceptions\ValueNotValid
   */
  public function setGenerationInterval(int $generationInterval)
  {
    AutomaticInstanceGeneration::ensureValidValue($generationInterval);
    $this->generationInterval = $generationInterval;
  }

  /**
   * @param \DateTime|null $openSyncFrom
   */
  public function setOpenSyncFrom(?\DateTime $openSyncFrom)
  {
    $this->openSyncFrom = $openSyncFrom;
  }

  /**
   * @param \DateTime|null $openSyncFromInProcess
   * @return $this|RankingSystem

The return type RankingSystem is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

   */
  public function setOpenSyncFromInProcess(?\DateTime $openSyncFromInProcess): RankingSystem
  {
    $this->openSyncFromInProcess = $openSyncFromInProcess;
    return $this;
  }

  /**
   * @param string $serviceName
   */
  public function setServiceName(string $serviceName)
  {
    $this->serviceName = $serviceName;
  }
//</editor-fold desc="Public Methods">

//<editor-fold desc="Protected Final Methods">
  /**
   * RankingSystem init
   * @param string[] $keys the keys of the subclass properties
   */
  protected final function init(array $keys)
  {
    $this->initSubClassData($keys);
    $this->generationInterval = AutomaticInstanceGeneration::OFF;
    $this->defaultForLevel = null;
    $this->openSyncFrom = null;
    $this->lists = new ArrayCollection();
    $this->hierarchyEntries = new ArrayCollection();
  }
//</editor-fold desc="Protected Final Methods">
}