Hyde\Framework\Services\RssFeedService

Complexity

Total Complexity

21

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getXML()	0	3	1
A	__construct()	0	11	3
A	addInitialChannelItems()	0	12	1
A	addItem()	0	9	1
A	generate()	0	8	2
A	generateFeed()	0	3	1
A	getDefaultOutputFilename()	0	3	1
A	getLink()	0	6	1
A	addAdditionalChannelData()	0	5	1
A	getDescription()	0	6	1
A	getTitle()	0	4	1
A	xmlEscape()	0	3	1
A	addAdditionalItemData()	0	19	6

<?php

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

namespace Hyde\Framework\Services;

use Hyde\Framework\Hyde;
use Hyde\Framework\Models\Pages\MarkdownPost;
use SimpleXMLElement;

/**
 * @see \Hyde\Framework\Testing\Feature\Services\RssFeedServiceTest
 * @see https://validator.w3.org/feed/docs/rss2.html
 * @phpstan-consistent-constructor
 */
class RssFeedService
{
    public SimpleXMLElement $feed;

    public function __construct()
    {
        if (! extension_loaded('simplexml') || config('testing.mock_disabled_extensions', false) === true) {
            throw new \Exception('The ext-simplexml extension is not installed, but is required to generate RSS feeds.');
        }

        $this->feed = new SimpleXMLElement('<?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->feed->addChild('channel');

        $this->addInitialChannelItems();
    }

    /**
     * @throws \Exception
     */
    public function generate(): static
    {
        /** @var MarkdownPost $post */
        foreach (MarkdownPost::getLatestPosts() as $post) {
            $this->addItem($post);
        }

        return $this;
    }

    public function getXML(): string|bool
    {
        return $this->feed->asXML();
    }

    protected function addItem(MarkdownPost $post): void
    {
        $item = $this->feed->channel->addChild('item');
        $item->addChild('title', $post->title);
        $item->addChild('link', $post->getCanonicalLink());

The function Hyde\Framework\Models\Pages\MarkdownPost::getCanonicalLink() has been deprecated: v0.58.x-beta (may be moved to BlogPostSchema)

        $item->addChild('guid', $post->getCanonicalLink());

The function Hyde\Framework\Models\Pages\MarkdownPost::getCanonicalLink() has been deprecated: v0.58.x-beta (may be moved to BlogPostSchema)

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

The function Hyde\Framework\Models\Pages\MarkdownPost::getPostDescription() has been deprecated: v0.58.x-beta (pull description instead)

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

    protected function addAdditionalItemData(SimpleXMLElement $item, MarkdownPost $post): void
    {
        if (isset($post->date)) {
            $item->addChild('pubDate', $post->date->dateTimeObject->format(DATE_RSS));
        }

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

The method getName() does not exist on null.

        }

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

        if (isset($post->image)) {
            $image = $item->addChild('enclosure');
            $image->addAttribute('url', Hyde::image($post->image, true));
            $image->addAttribute('type', str_ends_with($post->image->getSource(), '.png') ? 'image/png' : 'image/jpeg');

The method getSource() does not exist on null.

            $image->addAttribute('length', $post->image->getContentLength());
        }
    }

    protected function addInitialChannelItems(): void
    {
        $this->feed->channel->addChild('title', static::getTitle());
        $this->feed->channel->addChild('link', static::getLink());
        $this->feed->channel->addChild('description', static::getDescription());

        $atomLink = $this->feed->channel->addChild('atom:link', namespace: 'http://www.w3.org/2005/Atom');
        $atomLink->addAttribute('href', static::getLink().'/'.static::getDefaultOutputFilename());
        $atomLink->addAttribute('rel', 'self');
        $atomLink->addAttribute('type', 'application/rss+xml');

        $this->addAdditionalChannelData();
    }

    protected function addAdditionalChannelData(): void
    {
        $this->feed->channel->addChild('language', config('site.language', 'en'));
        $this->feed->channel->addChild('generator', 'HydePHP '.Hyde::version());
        $this->feed->channel->addChild('lastBuildDate', date(DATE_RSS));
    }

    protected static function xmlEscape(string $string): string
    {
        return htmlspecialchars($string, ENT_XML1 | ENT_COMPAT, 'UTF-8');
    }

    public static function getDescription(): string
    {
        return static::xmlEscape(
            config(
                'hyde.rss_description',
                static::getTitle().' RSS Feed'
            )
        );
    }

    public static function getTitle(): string
    {
        return static::xmlEscape(
            config('site.name', 'HydePHP')
        );
    }

    public static function getLink(): string
    {
        return static::xmlEscape(
            rtrim(
                config('site.url') ?? 'http://localhost',
                '/'
            )
        );
    }

    public static function getDefaultOutputFilename(): string
    {
        return config('hyde.rss_filename', 'feed.xml');
    }

    public static function generateFeed(): string
    {
        return (new static)->generate()->getXML();

The expression return new static()->generate()->getXML() could return the type true which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }
}