GpsLab\Component\Sitemap\Stream\RenderIndexFileStream

Complexity

Total Complexity

10

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	getFilename()	0	4	1
A	open()	0	6	1
A	close()	0	8	1
A	push()	0	15	3
A	addSubStreamFileToIndex()	0	13	1
A	getIndexPartFilename()	0	10	1
A	count()	0	4	1

<?php
/**
 * GpsLab component.
 *
 * @author    Peter Gribanov <info@peter-gribanov.ru>
 * @copyright Copyright (c) 2011, Peter Gribanov
 * @license   http://opensource.org/licenses/MIT
 */

namespace GpsLab\Component\Sitemap\Stream;

use GpsLab\Component\Sitemap\Render\SitemapIndexRender;
use GpsLab\Component\Sitemap\Render\SitemapRender;
use GpsLab\Component\Sitemap\Stream\Exception\OverflowException;
use GpsLab\Component\Sitemap\Stream\Exception\StreamStateException;
use GpsLab\Component\Sitemap\Stream\State\StreamState;
use GpsLab\Component\Sitemap\Url\Url;

class RenderIndexFileStream implements FileStream
{
    /**
     * @var SitemapIndexRender
     */
    private $render;

    /**
     * @var SitemapRender
     */
    private $substream;

    /**
     * @var StreamState
     */
    private $state;

    /**
     * @var string
     */
    private $host = '';

    /**
     * @var string
     */
    private $filename = '';

    /**
     * @var int
     */
    private $index = 0;

    /**
     * @var int
     */
    private $counter = 0;

    /**
     * @var string
     */
    private $buffer = '';

    /**
     * @param SitemapIndexRender $render
     * @param FileStream         $substream
     * @param string             $host
     * @param string             $filename
     */
    public function __construct(SitemapIndexRender $render, FileStream $substream, $host, $filename)
    {
        $this->render = $render;
        $this->substream = $substream;

It seems like $substream of type object<GpsLab\Component\Sitemap\Stream\FileStream> is incompatible with the declared type object<GpsLab\Component\Sitemap\Render\SitemapRender> of property $substream.

        $this->host = $host;
        $this->filename = $filename;
        $this->state = new StreamState();
    }

    /**
     * @return string
     */
    public function getFilename()
    {
        return $this->filename;
    }

    public function open()
    {
        $this->state->open();
        $this->substream->open();

The method open() does not seem to exist on object<GpsLab\Component\Sitemap\Render\SitemapRender>.

        $this->buffer = $this->render->start();
    }

    public function close()
    {
        $this->state->close();
        $this->addSubStreamFileToIndex();

        file_put_contents($this->filename, $this->buffer.$this->render->end());
        $this->buffer = '';
    }

    /**
     * @param Url $url
     */
    public function push(Url $url)
    {
        if (!$this->state->isReady()) {
            throw StreamStateException::notReady();
        }

        try {
            $this->substream->push($url);

The method push() does not seem to exist on object<GpsLab\Component\Sitemap\Render\SitemapRender>.

        } catch (OverflowException $e) {
            $this->addSubStreamFileToIndex();
            $this->substream->open();

The method open() does not seem to exist on object<GpsLab\Component\Sitemap\Render\SitemapRender>.

        }

        ++$this->counter;
    }

    private function addSubStreamFileToIndex()
    {
        $this->substream->close();

The method close() does not seem to exist on object<GpsLab\Component\Sitemap\Render\SitemapRender>.

        $filename = $this->substream->getFilename();

The method getFilename() does not seem to exist on object<GpsLab\Component\Sitemap\Render\SitemapRender>.

        $indexed_filename = $this->getIndexPartFilename($filename, ++$this->index);
        $last_mod = (new \DateTimeImmutable())->setTimestamp(filemtime($filename));

        // rename sitemap file to the index part file
        rename($filename, dirname($filename).'/'.$indexed_filename);

        $this->buffer .= $this->render->sitemap($this->host.$indexed_filename, $last_mod);

It seems like $last_mod defined by (new \DateTimeImmutable())->setTimestamp(filemtime($filename)) on line 125 can also be of type false; however, GpsLab\Component\Sitemap\Render\SitemapIndexRender::sitemap() does only seem to accept null|object<DateTimeImmutable>, did you maybe forget to handle an error condition?

    }

    /**
     * @param string $filename
     * @param int    $index
     *
     * @return string
     */
    private function getIndexPartFilename($filename, $index)
    {
        // use explode() for correct add index
        // sitemap.xml -> sitemap1.xml
        // sitemap.xml.gz -> sitemap1.xml.gz

        list($filename, $extension) = explode('.', basename($filename), 2);

        return sprintf('%s%s.%s', $filename, $index, $extension);
    }

    /**
     * @return int
     */
    public function count()
    {
        return $this->counter;
    }
}