Hyde\Framework\Features\XmlGenerators\BaseXmlGenerator

Complexity

Total Complexity

6

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getXml()	0	3	1
A	getXmlElement()	0	3	1
A	make()	0	3	1
A	__construct()	0	7	1
A	escape()	0	3	1
A	addChild()	0	3	1

<?php

/** @noinspection PhpComposerExtensionStubsInspection */

declare(strict_types=1);

namespace Hyde\Framework\Features\XmlGenerators;

use Exception;
use function extension_loaded;
use function htmlspecialchars;
use SimpleXMLElement;
use function throw_unless;

abstract class BaseXmlGenerator implements XmlGeneratorContract
{
    protected SimpleXMLElement $xmlElement;

    abstract protected function constructBaseElement(): void;

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

    public function __construct()
    {
        throw_unless(extension_loaded('simplexml'),
            new Exception('The SimpleXML extension is required to generate RSS feeds and sitemaps.')
        );

        $this->constructBaseElement();
    }

    public function getXml(): string
    {
        return (string) $this->xmlElement->asXML();
    }

    public function getXmlElement(): SimpleXMLElement
    {
        return $this->xmlElement;
    }

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

    protected function addChild(SimpleXMLElement $element, string $name, string $value): SimpleXMLElement
    {
        return $element->addChild($name, $this->escape($value));
    }
}