GpsLab\Component\Sitemap\Stream\RenderGzipFileStream

Complexity

Total Complexity

15

Size/Duplication

Total Lines	136
Duplicated Lines	26.47 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	4
A	getFilename()	0	4	1
A	open()	15	15	4
A	close()	0	6	1
A	push()	21	21	3
A	count()	0	4	1
A	write()	0	5	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\SitemapRender;
use GpsLab\Component\Sitemap\Stream\Exception\CompressionLevelException;
use GpsLab\Component\Sitemap\Stream\Exception\FileAccessException;
use GpsLab\Component\Sitemap\Stream\Exception\LinksOverflowException;
use GpsLab\Component\Sitemap\Stream\Exception\StreamStateException;
use GpsLab\Component\Sitemap\Stream\State\StreamState;
use GpsLab\Component\Sitemap\Url\Url;

class RenderGzipFileStream implements FileStream
{
    const LINKS_LIMIT = 50000;

    const BYTE_LIMIT = 52428800; // 50 Mb

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

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

    /**
     * @var resource|null
     */
    private $handle;

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

    /**
     * @var int
     */
    private $compression_level = 9;

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

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

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

    /**
     * @param SitemapRender $render
     * @param string        $filename
     * @param int           $compression_level
     */
    public function __construct(SitemapRender $render, $filename, $compression_level = 9)
    {
        if (!is_numeric($compression_level) || $compression_level < 1 || $compression_level > 9) {
            throw CompressionLevelException::invalid($compression_level, 1, 9);
        }

        $this->render = $render;
        $this->state = new StreamState();
        $this->filename = $filename;
        $this->compression_level = $compression_level;

It seems like $compression_level can also be of type double or string. However, the property $compression_level is declared as type integer. Maybe add an additional type check?

    }

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

    public function open()

This method seems to be duplicated in your project.

    {
        $this->state->open();

        $mode = 'wb'.$this->compression_level;
        if ((file_exists($this->filename) && !is_writable($this->filename)) ||
            ($this->handle = @gzopen($this->filename, $mode)) === false
        ) {
            throw FileAccessException::notWritable($this->filename);
        }

        $this->write($this->render->start());
        // render end string only once
        $this->end_string = $this->render->end();
    }

    public function close()
    {
        $this->state->close();
        $this->write($this->end_string);
        gzclose($this->handle);
    }

    /**
     * @param Url $url
     */
    public function push(Url $url)

This method seems to be duplicated in your project.

    {
        if (!$this->state->isReady()) {
            throw StreamStateException::notReady();
        }

        if ($this->counter >= self::LINKS_LIMIT) {
            throw LinksOverflowException::withLimit(self::LINKS_LIMIT);
        }

        $render_url = $this->render->url($url);

        // impossible calculate expected size
//        $expected_bytes = $this->used_bytes + strlen($render_url) + strlen($this->end_string);
//        if ($expected_bytes > self::BYTE_LIMIT) {
//            throw SizeOverflowException::withLimit(self::BYTE_LIMIT);
//        }

        $this->write($render_url);
        ++$this->counter;
    }

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

    /**
     * @param string $string
     */
    private function write($string)
    {
        gzwrite($this->handle, $string);
//        $this->used_bytes += strlen($string);
    }
}