nexendrie / rss

src/Generator.php

<?php
declare(strict_types=1);

namespace Nexendrie\Rss;

use Nexendrie\Rss\Extensions\RssCore;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Nette\Utils\Arrays;

/**
 * RSS Channel Generator
 *
 * @author Jakub Konečný
 * @property callable|null $dataSource
 * @property string $template
 * @method void onBeforeGenerate(Generator $generator, array $info)
 * @method void onAddItem(Generator $generator, \SimpleXMLElement $channel, RssChannelItem $itemDefinition, \SimpleXMLElement $item)

Line exceeds 120 characters; contains 132 characters

 * @method void onAfterGenerate(Generator $generator, array $info)
 */
final class Generator {
  use \Nette\SmartObject;

  private const NAMESPACE_ATTRIBUTE_HACK = "__extension_namespace__";

  public string $dateTimeFormat = "r";
  /** @var callable|null */
  private $dataSource = null;
  public int $shortenDescription = 150;
  public string $generator = "Nexendrie RSS";
  public string $docs = "http://www.rssboard.org/rss-specification";
  private string $template = __DIR__ . "/template.xml";
  /** @var RssExtensionsCollection|IRssExtension[] */
  public RssExtensionsCollection $extensions;
  /** @var callable[] */
  public array $onBeforeGenerate = [];
  /** @var callable[] */
  public array $onAddItem = [];
  /** @var callable[] */
  public array $onAfterGenerate = [];

  public function __construct() {
    $this->extensions = RssExtensionsCollection::fromArray([new RssCore()]);
  }

  protected function getDataSource(): ?callable {
    return $this->dataSource;
  }

  protected function setDataSource(callable $dataSource): void {
    $this->dataSource = $dataSource;
  }

  protected function getTemplate(): string {
    return $this->template;
  }

  /**
   * @throws \RuntimeException
   */
  protected function setTemplate(string $template): void {
    if(!is_file($template) || !is_readable($template)) {
      throw new \RuntimeException("File $template does not exist or is not readable.");
    }
    $this->template = $template;
  }
  
  /**
   * @throws InvalidStateException
   * @throws \InvalidArgumentException
   */
  private function getData(): Collection {
    if($this->dataSource === null) {
      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;
  }

  private function writeProperty(\SimpleXMLElement &$channel, array $info, string $property): void {
    $value = Arrays::get($info, $property, "");
    if(!$value instanceof IXmlConvertible) {
      $value = new GenericElement($property, $value);
    }
    $value->appendToXml($channel->channel);
  }

  /**
   * @throws InvalidStateException
   * @throws \InvalidArgumentException
   */
  public function generate(array $info): string {
    $this->onBeforeGenerate($this, $info);
    $items = $this->getData();
    $resolver = new OptionsResolver();
    foreach($this->extensions as $extension) {
      $extension->configureChannelOptions($resolver, $this);
    }
    $info = $resolver->resolve($info);
    /** @var \SimpleXMLElement $channel */
    $channel = simplexml_load_file($this->template);
    foreach($this->extensions as $extension) {
      if($extension->getName() !== "" && $extension->getNamespace() !== "") {
        $channel->addAttribute(static::NAMESPACE_ATTRIBUTE_HACK . $extension->getName(), $extension->getNamespace());
      }
    }
    $properties = $resolver->getDefinedOptions();
    foreach($properties as $property) {
      $this->writeProperty($channel, $info, $property);
    }
    if($this->generator !== "") {
      $channel->channel->generator = $this->generator;
    }
    if($this->docs !== "") {
      $channel->channel->docs = $this->docs;
    }
    /** @var RssChannelItem $item */
    foreach($items as $item) {
      /** @var \SimpleXMLElement $i */
      $i = $channel->channel->addChild("item");
      $item->toXml($i, $this);
      $this->onAddItem($this, $channel, $item, $i);
    }
    $this->onAfterGenerate($this, $info);
    $dom = new \DOMDocument();
    $dom->preserveWhiteSpace = false;
    $dom->formatOutput = true;
    $xml = $channel->asXML();
    $xml = str_replace(static::NAMESPACE_ATTRIBUTE_HACK, "xmlns:", $xml);
    $dom->loadXML($xml);
    return (string) $dom->saveXML();
  }
  
  /**
   * @throws InvalidStateException
   * @throws \InvalidArgumentException
   */
  public function response(array $info): RssResponse {
    return new RssResponse($this->generate($info));
  }
}
?>