Hyde\Framework\Features\XmlGenerators\RssFeedGenerator

Complexity

Total Complexity

16

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	generate()	0	7	1
A	getDescription()	0	3	1
A	getImageType()	0	3	1
A	getImageLength()	0	3	1
A	addBaseChannelItems()	0	10	1
A	getFilename()	0	3	1
A	addItem()	0	8	1
A	getChannel()	0	5	1
A	constructBaseElement()	0	11	1
A	addDynamicItemData()	0	25	6
A	addAtomLinkItem()	0	7	1

<?php

/** @noinspection PhpComposerExtensionStubsInspection */
/** @noinspection XmlUnusedNamespaceDeclaration */

declare(strict_types=1);

namespace Hyde\Framework\Features\XmlGenerators;

use Hyde\Hyde;
use SimpleXMLElement;
use Hyde\Facades\Site;
use Hyde\Facades\Config;
use Hyde\Pages\MarkdownPost;
use Hyde\Facades\Filesystem;
use Hyde\Framework\Features\Blogging\Models\FeaturedImage;

use function date;
use function assert;
use function sprintf;
use function implode;

/**
 * @see https://validator.w3.org/feed/docs/rss2.html
 */
class RssFeedGenerator extends BaseXmlGenerator
{
    public function generate(): static
    {
        MarkdownPost::getLatestPosts()->each(function (MarkdownPost $post): void {
            $this->addItem($post);
        });

        return $this;
    }

    protected function constructBaseElement(): void
    {
        $this->xmlElement = new SimpleXMLElement(implode("\n", [
            '<?xml version="1.0" encoding="UTF-8"?>',
            '<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/" />',
        ]));

        $this->xmlElement->addChild('channel');

        $this->addBaseChannelItems();
        $this->addAtomLinkItem();
    }

    protected function addItem(MarkdownPost $post): void
    {
        $item = $this->getChannel()->addChild('item');

        $this->addChild($item, 'title', $post->title);
        $this->addChild($item, 'description', $post->description);

It seems like $post->description can also be of type null; however, parameter $value of Hyde\Framework\Features\XmlGenerators\BaseXmlGenerator::addChild() does only seem to accept string, maybe add an additional type check?

        $this->addDynamicItemData($item, $post);
    }

    protected function addDynamicItemData(SimpleXMLElement $item, MarkdownPost $post): void
    {
        if ($post->getCanonicalUrl() !== null) {
            $this->addChild($item, 'link', $post->getCanonicalUrl());
            $this->addChild($item, 'guid', $post->getCanonicalUrl());
        }

        if (isset($post->date)) {
            $this->addChild($item, 'pubDate', $post->date->format(DATE_RSS));

The method format() does not exist on null.

The method format() does not exist on Hyde\Support\Models\DateString. Since you implemented __call, consider adding a @method annotation.

        }

        if (isset($post->author)) {
            $item->addChild('dc:creator', $post->author->name, 'http://purl.org/dc/elements/1.1/');
        }

        if (isset($post->category)) {
            $this->addChild($item, 'category', $post->category);

It seems like $post->category can also be of type null; however, parameter $value of Hyde\Framework\Features\XmlGenerators\BaseXmlGenerator::addChild() does only seem to accept string, maybe add an additional type check?

        }

        if (isset($post->image)) {
            $image = $item->addChild('enclosure');

            $image->addAttribute('url', Hyde::url($post->image->getSource()));

The method getSource() does not exist on null.

The method url() does not exist on Hyde\Hyde. Since you implemented __callStatic, consider adding a @method annotation.

            $image->addAttribute('type', $this->getImageType($post->image));

It seems like $post->image can also be of type null; however, parameter $image of Hyde\Framework\Features\XmlGenerators\RssFeedGenerator::getImageType() does only seem to accept Hyde\Framework\Features\Blogging\Models\FeaturedImage, maybe add an additional type check?

            $image->addAttribute('length', $this->getImageLength($post->image));

It seems like $post->image can also be of type null; however, parameter $image of Hyde\Framework\Features\XmlGenerators\RssFeedGenerator::getImageLength() does only seem to accept Hyde\Framework\Features\Blogging\Models\FeaturedImage, maybe add an additional type check?

        }
    }

    protected function addBaseChannelItems(): void
    {
        $channel = $this->getChannel();

        $this->addChild($channel, 'title', Site::name());

It seems like Hyde\Facades\Site::name() can also be of type null; however, parameter $value of Hyde\Framework\Features\XmlGenerators\BaseXmlGenerator::addChild() does only seem to accept string, maybe add an additional type check?

        $this->addChild($channel, 'link', Site::url());
        $this->addChild($channel, 'description', $this->getDescription());
        $this->addChild($channel, 'language', Config::getString('hyde.language', 'en'));
        $this->addChild($channel, 'generator', 'HydePHP '.Hyde::version());
        $this->addChild($channel, 'lastBuildDate', date(DATE_RSS));
    }

    protected function addAtomLinkItem(): void
    {
        $atomLink = $this->getChannel()->addChild('atom:link', namespace: 'http://www.w3.org/2005/Atom');

        $atomLink->addAttribute('href', $this->escape(Hyde::url($this->getFilename())));
        $atomLink->addAttribute('rel', 'self');
        $atomLink->addAttribute('type', 'application/rss+xml');
    }

    protected function getImageType(FeaturedImage $image): string
    {
        return Filesystem::findMimeType($image->getSource());
    }

    /** @return numeric-string */

The doc comment numeric-string at position 0 could not be parsed: Unknown type name 'numeric-string' at position 0 in numeric-string.

    protected function getImageLength(FeaturedImage $image): string
    {
        return (string) $image->getContentLength();
    }

    public static function getFilename(): string
    {
        return Config::getString('hyde.rss.filename', 'feed.xml');
    }

    public static function getDescription(): string
    {
        return Config::getString('hyde.rss.description', sprintf('%s RSS Feed', Site::name()));
    }

    protected function getChannel(): SimpleXMLElement
    {
        assert($this->xmlElement->channel instanceof SimpleXMLElement);

        return $this->xmlElement->channel;
    }
}