HeroesofAbenez\Chat\ChatControl

Complexity

Total Complexity

23

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Test Coverage

Coverage

74.55%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	addMessageProcessor()	0	2	1
A	setCharacterProfileLink()	0	2	1
A	render()	0	7	1
A	setMessagesPerPage()	0	5	2
A	getCharacterProfileLink()	0	2	1
A	getMessagesPerPage()	0	2	1
A	getLang()	0	2	1
A	setLang()	0	3	1
A	getTexts()	0	2	1
A	getTranslator()	0	2	1
A	processMessage()	0	8	3
A	setupTranslator()	0	10	3
A	getCharacters()	0	2	1
A	__construct()	0	10	2
A	newMessage()	0	8	2
A	setTranslator()	0	3	1

<?php
declare(strict_types=1);

namespace HeroesofAbenez\Chat;

use Nette\Localization\ITranslator;
use Nexendrie\Translation\Translator;
use Nexendrie\Translation\Loaders\NeonLoader;

/**
 * Basic Chat Control
 *
 * @author Jakub Konečný
 * @property ITranslator $translator
 * @property string $lang
 * @property int $messagesPerPage
 * @property string $characterProfileLink
 * @property-read \Nette\Bridges\ApplicationLatte\Template $template
 */
abstract class ChatControl extends \Nette\Application\UI\Control {
  /** @var IDatabaseAdapter */
  protected $database;
  /** @var ITranslator|Translator|null */
  protected $translator;
  /** @var string */
  protected $lang = "";
  /** @var IChatMessageProcessor[] */
  protected $messageProcessors = [];
  /** @var string*/
  protected $textColumn;
  /** @var string */
  protected $characterColumn;
  /** @var int*/
  protected $textValue;
  /** @var int */
  protected $characterValue;
  /** @var string */
  protected $characterProfileLink = "";
  /** @var string */
  protected $templateFile = __DIR__ . "/chat.latte";
  /** @var int */
  protected $messagesPerPage = 25;

  /**
   * @param mixed $characterValue
   */
  public function __construct(IDatabaseAdapter $databaseAdapter, string $textColumn, int $textValue, string $characterColumn = null, $characterValue = null, ITranslator $translator = null) {

Line exceeds 120 characters; contains 190 characters

    if(!is_null($translator)) {
      trigger_error("Passing translator to constructor of" . self::class . " is deprecated.", E_USER_DEPRECATED);
    }
    $this->database = $databaseAdapter;
    $this->translator = $translator;
    $this->textColumn = $textColumn;
    $this->characterColumn = $characterColumn ?? $textColumn;
    $this->textValue = $textValue;
    $this->characterValue = $characterValue ?? $textValue;
  }

  /**
   * @deprecated
   */
  public function getTranslator(): ?ITranslator {
    return $this->translator;
  }

  /**
   * @deprecated
   */
  public function setTranslator(ITranslator $translator): void {
    trigger_error(__METHOD__ . "() is deprecated.", E_USER_DEPRECATED);
    $this->translator = $translator;
  }

  /**
   * @deprecated
   */
  public function getLang(): string {
    return $this->lang;
  }

  /**
   * @deprecated
   */
  public function setLang(string $lang): void {
    trigger_error(__METHOD__ . "() is deprecated.", E_USER_DEPRECATED);
    $this->lang = $lang;
  }
  
  public function getMessagesPerPage(): int {
    return $this->messagesPerPage;
  }
  
  public function setMessagesPerPage(int $messagesPerPage): void {
    if($messagesPerPage < 0) {
      $messagesPerPage = 0;
    }
    $this->messagesPerPage = $messagesPerPage;
  }
  
  public function getCharacterProfileLink(): string {
    return $this->characterProfileLink;
  }
  
  public function setCharacterProfileLink(string $characterProfileLink): void {
    $this->characterProfileLink = $characterProfileLink;
  }
  
  public function addMessageProcessor(IChatMessageProcessor $processor): void {
    $this->messageProcessors[] = $processor;
  }
  
  /**
   * Gets texts for the current chat
   */
  public function getTexts(): ChatMessagesCollection {
    return $this->database->getTexts($this->textColumn, $this->textValue, $this->messagesPerPage);
  }
  
  /**
   * Gets characters in the current chat
   */
  public function getCharacters(): ChatCharactersCollection {
    return $this->database->getCharacters($this->characterColumn, $this->characterValue);
  }

  /**
   * @deprecated
   */
  protected function setupTranslator(): void {
    if(is_null($this->translator)) {
      $loader = new NeonLoader();
      $loader->folders = [__DIR__ . "/lang"];
      $this->translator = new Translator($loader);
    }
    if($this->lang !== "") {
      $this->translator->lang = $this->lang;
    }
    $this->template->setTranslator($this->translator);
  }
  
  /**
   * Renders the chat
   */
  public function render(): void {
    $this->setupTranslator();

The function HeroesofAbenez\Chat\ChatControl::setupTranslator() has been deprecated.

    $this->template->setFile($this->templateFile);
    $this->template->characters = $this->getCharacters();
    $this->template->texts = $this->getTexts();
    $this->template->characterProfileLink = $this->characterProfileLink;
    $this->template->render();
  }
  
  protected function processMessage(string $message): ?string {
    foreach($this->messageProcessors as $processor) {
      $result = $processor->parse($message);
      if(is_string($result)) {
        return $result;
      }
    }
    return null;
  }
  
  /**
   * Submits new message
   */
  public function newMessage(string $message): void {
    $result = $this->processMessage($message);
    if(!is_null($result)) {
      $this->presenter->flashMessage($result);
    } else {
      $this->database->addMessage($message, $this->textColumn, $this->textValue);
    }
    $this->presenter->redirect("this");
  }
}
?>