Wszetko\Sitemap\Drivers\Output\OutputXMLWriter

Complexity

Total Complexity

33

Size/Duplication

Total Lines	235
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
B	addElementArrayAssoc()	0	25	9
A	addUrl()	0	7	2
A	openSitemapIndex()	0	11	1
A	getXMLWriter()	0	3	1
A	__construct()	0	4	1
A	openSitemap()	0	16	2
A	addElement()	0	19	6
A	closeSitemap()	0	8	1
A	flushData()	0	3	1
A	addSitemap()	0	11	2
A	closeSitemapIndex()	0	8	1
A	endFile()	0	18	4
A	getSitemapSize()	0	5	2

<?php

declare(strict_types=1);

/**
 * This file is part of Wszetko Sitemap.
 *
 * (c) Paweł Kłopotek-Główczewski <pawelkg@pawelkg.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Wszetko\Sitemap\Drivers\Output;

use Exception;
use Wszetko\Sitemap\Sitemap;
use XMLWriter;

/**
 * Class XMLWriter.
 *
 * @package Wszetko\Sitemap\Drivers\XML
 */
class OutputXMLWriter extends AbstractOutput
{
    /**
     * Object which will be used to create XML files.
     *
     * @var mixed
     */
    private $XMLWriter;

    /**
     * @inheritDoc
     *
     * @throws \InvalidArgumentException
     */
    public function __construct(array $config)
    {
        parent::__construct($config);
        $this->XMLWriter = new XMLWriter();
    }

    /**
     * Return XMLWriter object.
     *
     * @return mixed
     */
    protected function getXMLWriter()
    {
        return $this->XMLWriter;
    }

    /**
     * @inheritDoc
     */
    public function openSitemap(string $sitemap, array $extensions = []): void
    {
        $this->setCurrentSitemap($sitemap);
        /** @var \XMLWriter $xmlWriter */
        $xmlWriter = $this->getXMLWriter();
        $xmlWriter->openMemory();
        $xmlWriter->startDocument('1.0', 'UTF-8');
        $xmlWriter->setIndent(true);
        $xmlWriter->startElement('urlset');
        $xmlWriter->writeAttribute('xmlns', Sitemap::SCHEMA);

        foreach ($extensions as $extension => $urlset) {
            $this->getXMLWriter()->writeAttribute('xmlns:' . $extension, $urlset);
        }

        $this->flushData();
    }

    /**
     * @inheritDoc
     *
     * @throws \Exception
     */
    public function closeSitemap(): void
    {
        /** @var \XMLWriter $xmlWriter */
        $xmlWriter = $this->getXMLWriter();
        $xmlWriter->endElement();
        $xmlWriter->endDocument();
        $this->flushData();
        $this->endFile();
    }

    /**
     * @inheritDoc
     */
    public function getSitemapSize(): int
    {
        clearstatcache(true, $this->getSitemapFileFullPath());

        return file_exists($this->getSitemapFileFullPath()) ? (int) filesize($this->getSitemapFileFullPath()) : 0;
    }

    /**
     * @inheritDoc
     */
    public function addUrl(array $element): void
    {
        foreach ($element as $el => $val) {
            $this->addElement($el, $val);
        }

        $this->flushData();
    }

    /**
     * @inheritDoc
     */
    public function openSitemapIndex(string $sitemap): void
    {
        $this->setCurrentSitemap($sitemap);
        /** @var \XMLWriter $xmlWriter */
        $xmlWriter = $this->getXMLWriter();
        $xmlWriter->openMemory();
        $xmlWriter->startDocument('1.0', 'UTF-8');
        $xmlWriter->setIndent(true);
        $xmlWriter->startElement('sitemapindex');
        $xmlWriter->writeAttribute('xmlns', Sitemap::SCHEMA);
        $this->flushData();
    }

    /**
     * @inheritDoc
     *
     * @throws \Exception
     */
    public function closeSitemapIndex(): void
    {
        /** @var \XMLWriter $xmlWriter */
        $xmlWriter = $this->getXMLWriter();
        $xmlWriter->endElement();
        $xmlWriter->endDocument();
        $this->flushData();
        $this->endFile();
    }

    /**
     * @inheritDoc
     */
    public function addSitemap(string $sitemap, string $lastmod = null): void
    {
        /** @var \XMLWriter $xmlWriter */
        $xmlWriter = $this->getXMLWriter();
        $xmlWriter->startElement('sitemap');
        $xmlWriter->writeElement('loc', $sitemap);
        if (isset($lastmod)) {
            $xmlWriter->writeElement('lastmod', $lastmod);
        }
        $xmlWriter->endElement();
        $this->flushData();
    }

    /**
     * Save from buffer to file.
     *
     * @return void
     */
    private function flushData(): void
    {
        file_put_contents($this->getSitemapFileFullPath(), $this->getXMLWriter()->flush(true), FILE_APPEND);
    }

    /**
     * Remove whitespace chars from end of file (Google don't like them) and close file.
     *
     * @throws Exception
     *
     * @return void
     */
    private function endFile(): void
    {
        $sitemapFile = fopen($this->getSitemapFileFullPath(), 'r+');

        if (false !== $sitemapFile) {
            fseek($sitemapFile, -1, SEEK_END);
            $truncate = 0;
            $length = $this->getSitemapSize();
            $char = fread($sitemapFile, 1);

            while (is_string($char) && ctype_space($char)) {
                ++$truncate;
                fseek($sitemapFile, -2, SEEK_CUR);
                $char = fread($sitemapFile, 1);
            }

            ftruncate($sitemapFile, $length - $truncate);
            fclose($sitemapFile);
        }
    }

    /**
     * Add element to current file.
     *
     * @param string      $element
     * @param mixed       $value
     * @param null|string $namespace
     */
    private function addElement(string $element, $value, ?string $namespace = null): void
    {
        if (!is_array($value)) {
            /** @var \XMLWriter $xmlWriter */
            $xmlWriter = $this->getXMLWriter();
            $xmlWriter->writeElement(($namespace !== null ? $namespace . ':' : '') . $element, (string) $value);

            return;
        }

        if (isset($value['_namespace'])) {
            $this->addElement($value['_element'], $value[$value['_element']], $value['_namespace']);
        } else {
            if (!$this->isAssoc($value)) {
                foreach ($value as $val) {
                    $this->addElement($element, $val, $namespace);
                }
            } else {
                $this->addElementArrayAssoc($element, $value, $namespace);
            }
        }
    }

    /**
     * Add element of associate array to current file.
     *
     * @param string      $element
     * @param mixed       $value
     * @param string|null $namespace
     */
    private function addElementArrayAssoc(string $element, $value, ?string $namespace = null): void
    {
        /** @var \XMLWriter $xmlWriter */
        $xmlWriter = $this->getXMLWriter();
        $xmlWriter->startElement(($namespace !== null ? $namespace . ':' : '') . $element);

        if (isset($value['_attributes'])) {
            foreach ($value['_attributes'] as $attribute => $val) {
                $xmlWriter->writeAttribute($attribute, $val);
            }

            if (isset($value['_value']) && is_string($value['_value'])) {
                $xmlWriter->text($value['_value']);
            }
        } else {
            foreach ($value as $el => $val) {
                if (is_array($val)) {
                    $this->addElement($el, $val, $namespace);
                } else {
                    $xmlWriter->writeElement(($namespace !== null ? $namespace . ':' : '') . $el, (string) $val);
                }
            }
        }

        $xmlWriter->endElement();
    }
}