Nexendrie\Rss\Generator

Complexity

Total Complexity

45

Size/Duplication

Total Lines	243
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	setManagingEditor()	0	2	1
A	setLastBuildDate()	0	2	1
A	getManagingEditor()	0	2	1
A	setLanguage()	0	2	1
A	getCopyright()	0	2	1
A	setShortenDescription()	0	2	1
A	getDescription()	0	2	1
A	setWebMaster()	0	2	1
A	setCopyright()	0	2	1
A	getTemplate()	0	2	1
A	response()	0	2	1
A	setGenerator()	0	2	1
A	getData()	0	9	3
A	generate()	0	36	3
A	getLastBuildDate()	0	2	1
A	getDateTimeFormat()	0	2	1
A	getShortenDescription()	0	2	1
A	setTemplate()	0	5	2
A	getLink()	0	2	1
A	writeItemProperty()	0	7	4
A	setLink()	0	2	1
A	writeProperty()	0	3	3
A	getTitle()	0	2	1
A	setDateTimeFormat()	0	2	1
A	getLanguage()	0	2	1
A	getGenerator()	0	2	1
A	setTitle()	0	2	1
A	setDataSource()	0	2	1
A	getWebMaster()	0	2	1
A	getDocs()	0	2	1
A	setDescription()	0	2	1
A	shortenDescription()	0	10	3
A	setDocs()	0	2	1

<?php
declare(strict_types=1);

namespace Nexendrie\Rss;

/**
 * RSS Channel Generator
 *
 * @author Jakub Konečný
 * @property string $title
 * @property string $description
 * @property string $link
 * @property string $language
 * @property string $copyright
 * @property string $managingEditor
 * @property string $webMaster
 * @property callable $dataSource
 * @property int $shortenDescription
 * @property string $dateTimeFormat
 * @property callable $lastBuildDate
 * @property string $generator
 * @property string $docs
 * @property string $template
 * @method void onBeforeGenerate(Generator $generator)
 * @method void onAddItem(Generator $generator, \SimpleXMLElement $channel, RssChannelItem $itemDefinition, \SimpleXMLElement $item)

Line exceeds 120 characters; contains 132 characters

 * @method void onAfterGenerate(Generator $generator)
 */
final class Generator {
  use \Nette\SmartObject;
  
  /** @var string */
  protected $title = "";
  /** @var string */
  protected $description = "";
  /** @var string */
  protected $link = "";
  /** @var string */
  protected $language = "";
  /** @var string */
  protected $copyright = "";
  /** @var string */
  protected $managingEditor = "";
  /** @var string */
  protected $webMaster = "";
  /** @var string */
  protected $dateTimeFormat = "Y-m-d H:i:s";
  /** @var callable|null */
  protected $dataSource = null;
  /** @var int */
  protected $shortenDescription = 150;
  /** @var callable */
  protected $lastBuildDate = "time";
  /** @var string */
  protected $generator = "Nexendrie RSS";
  /** @var string */
  protected $docs = "http://blogs.law.harvard.edu/tech/rss";
  /** @var string */
  protected $template = __DIR__ . "/template.xml";
  /** @var callable[] */
  public $onBeforeGenerate = [];
  /** @var callable[] */
  public $onAddItem = [];
  /** @var callable[] */
  public $onAfterGenerate = [];
  
  public function getTitle(): string {
    return $this->title;
  }
  
  public function setTitle(string $title): void {
    $this->title = $title;
  }
  
  public function getDescription(): string {
    return $this->description;
  }
  
  public function setDescription(string $description): void {
    $this->description = $description;
  }
  
  public function getLink(): string {
    return $this->link;
  }
  
  public function setLink(string $link): void {
    $this->link = $link;
  }

  public function getLanguage(): string {
    return $this->language;
  }

  public function setLanguage(string $language): void {
    $this->language = $language;
  }

  public function getCopyright(): string {
    return $this->copyright;
  }

  public function setCopyright(string $copyright): void {
    $this->copyright = $copyright;
  }

  public function getManagingEditor(): string {
    return $this->managingEditor;
  }

  public function setManagingEditor(string $managingEditor): void {
    $this->managingEditor = $managingEditor;
  }

  public function getWebMaster(): string {
    return $this->webMaster;
  }

  public function setWebMaster(string $webMaster): void {
    $this->webMaster = $webMaster;
  }

  public function setDataSource(callable $dataSource): void {
    $this->dataSource = $dataSource;
  }
  
  public function getShortenDescription(): int {
    return $this->shortenDescription;
  }
  
  public function setShortenDescription(int $value): void {
    $this->shortenDescription = $value;
  }
  
  public function getDateTimeFormat(): string {
    return $this->dateTimeFormat;
  }
  
  public function setDateTimeFormat(string $format): void {
    $this->dateTimeFormat = $format;
  }
  
  public function getLastBuildDate(): callable {
    return $this->lastBuildDate;
  }
  
  public function setLastBuildDate(callable $lastBuildDate): void {
    $this->lastBuildDate = $lastBuildDate;
  }

  public function getGenerator(): string {
    return $this->generator;
  }

  public function setGenerator(string $generator): void {
    $this->generator = $generator;
  }

  public function getDocs(): string {
    return $this->docs;
  }

  public function setDocs(string $docs): void {
    $this->docs = $docs;
  }
  
  public function getTemplate(): string {
    return $this->template;
  }
  
  /**
   * @throws \RuntimeException
   */
  public function setTemplate(string $template): void {
    if(!is_file($template)) {
      throw new \RuntimeException("File $template does not exist.");
    }
    $this->template = $template;
  }
  
  /**
   * @throws InvalidStateException
   * @throws \InvalidArgumentException
   */
  protected function getData(): Collection {
    if(is_null($this->dataSource)) {

The condition is_null($this->dataSource) is always false.

      throw new InvalidStateException("Data source for RSS generator is not set.");
    }
    $items = call_user_func($this->dataSource);
    if(!$items instanceof Collection) {
      throw new \InvalidArgumentException("Callback for data source for RSS generator has to return an instance of  " . Collection::class . ".");

Line exceeds 120 characters; contains 145 characters

    }
    return $items;
  }
  
  protected function shortenDescription(string $description): string {
    if($this->shortenDescription < 1) {
      return $description;
    }
    $originalDescription = $description;
    $description = substr($description, 0, $this->shortenDescription);
    if($description !== $originalDescription) {
      $description .= "...";
    }
    return $description;
  }
  
  protected function writeProperty(\SimpleXMLElement &$channel, string $property): void {
    if(isset($this->$property) AND $this->$property !== "") {
      $channel->channel->{$property}[0][0] = $this->$property;
    }
  }

  protected function writeItemProperty(\SimpleXMLElement $element, RssChannelItem $item, string $property, callable $callback = null): void {

Line exceeds 120 characters; contains 141 characters

    if(isset($item->$property) AND $item->$property !== "") {
      $value = $item->$property;
      if(!is_null($callback)) {
        $value = $callback($value);
      }
      $element->addChild($property, $value);
    }
  }
  
  /**
   * @throws InvalidStateException
   * @throws \InvalidArgumentException
   */
  public function generate(): string {
    $this->onBeforeGenerate($this);
    $items = $this->getData();
    $lastBuildDate = call_user_func($this->lastBuildDate);
    if(!is_int($lastBuildDate)) {
      throw new \InvalidArgumentException("Callback for last build date for RSS generator has to return integer.");
    }
    /** @var \SimpleXMLElement $channel */
    $channel = simplexml_load_file($this->template);
    $channel->channel->lastBuildDate[0][0] = date($this->dateTimeFormat, $lastBuildDate);
    $this->writeProperty($channel, "link");
    $this->writeProperty($channel, "title");
    $this->writeProperty($channel, "description");
    $this->writeProperty($channel, "language");
    $this->writeProperty($channel, "copyright");
    $this->writeProperty($channel, "managingEditor");
    $this->writeProperty($channel, "webMaster");
    $this->writeProperty($channel, "generator");
    $this->writeProperty($channel, "docs");
    /** @var RssChannelItem $item */
    foreach($items as $item) {
      /** @var \SimpleXMLElement $i */
      $i = $channel->channel->addChild("item");
      $this->writeItemProperty($i, $item, "title");
      $this->writeItemProperty($i, $item, "link");
      $this->writeItemProperty($i, $item, "pubDate", function($value) {
        return date($this->dateTimeFormat, $value);
      });
      $this->writeItemProperty($i, $item, "description", [$this, "shortenDescription"]);
      $this->writeItemProperty($i, $item, "author");
      $this->writeItemProperty($i, $item, "comments");
      $this->writeItemProperty($i, $item, "guid");
      $this->onAddItem($this, $channel, $item, $i);
    }
    $this->onAfterGenerate($this);
    return $channel->asXML();
  }
  
  /**
   * @throws InvalidStateException
   * @throws \InvalidArgumentException
   */
  public function response(): RssResponse {
    return new RssResponse($this->generate());
  }
}
?>