OneSheet\Finalizer

Complexity

Total Complexity

12

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

95.92%

Importance

Changes	10
Bugs	6	Features	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	finalize()	0	11	2
A	fillZipWithFileContents()	0	7	1
A	finalizeSheet()	0	10	1
A	finalizeStyles()	0	4	1
A	finalizeDefaultXmls()	0	10	1
B	copyToOutputAndCleanup()	0	11	5

<?php

namespace OneSheet;

use OneSheet\Style\Styler;
use OneSheet\Xml\DefaultXml;
use OneSheet\Xml\SheetXml;

/**
 * Class Finalizer, a rather quick and dirty solution for now.
 *
 * @package OneSheet
 */
class Finalizer
{
    /**
     * @var Sheet
     */
    private $sheet;

    /**
     * @var SheetFile
     */
    private $sheetFile;

    /**
     * @var \ZipArchive
     */
    private $zip;

    /**
     * @var Styler
     */
    private $styler;

    /**
     * Finalizer constructor.
     *
     * @param Sheet     $sheet
     * @param Styler    $styler
     * @param SheetFile $sheetFile
     */
    public function __construct(Sheet $sheet, Styler $styler, SheetFile $sheetFile)
    {
        $this->sheet = $sheet;
        $this->styler = $styler;
        $this->sheetFile = $sheetFile;
        $this->zip = new \ZipArchive();
    }

    /**
     * Finalize the xlsx file.
     *
     * @param resource $output
     */
    public function finalize($output)
    {
        $zipFileUrl = sys_get_temp_dir() . '/' . uniqid();

        $this->fillZipWithFileContents($zipFileUrl);
        if (!$this->zip->close()) {
            throw new \RuntimeException('Failed to close zip file!');
        }

        $this->copyToOutputAndCleanup($output, $zipFileUrl);
    }

    /**
     * Add all file and string contents to zip file.
     *
     * @param string $zipFileUrl
     */
    private function fillZipWithFileContents($zipFileUrl)
    {
        $this->zip->open($zipFileUrl, \ZipArchive::CREATE);
        $this->finalizeSheet();
        $this->finalizeStyles();
        $this->finalizeDefaultXmls();
    }

    /**
     * Wrap up the sheet (write header, column xmls).
     */
    private function finalizeSheet()
    {
        $this->sheetFile->fwrite('</sheetData></worksheet>');
        $this->sheetFile->rewind();
        $this->sheetFile->fwrite(SheetXml::HEADER_XML);
        $this->sheetFile->fwrite($this->sheet->getDimensionXml());
        $this->sheetFile->fwrite($this->sheet->getSheetViewsXml());
        $this->sheetFile->fwrite($this->sheet->getColsXml());
        $this->zip->addFile($this->sheetFile->getFilePath(), 'xl/worksheets/sheet1.xml');
    }

    /**
     * Write style xml file.
     */
    private function finalizeStyles()
    {
        $this->zip->addFromString('xl/styles.xml', $this->styler->getStyleSheetXml());
    }

    /**
     * Add default xmls to zip archive.
     */
    private function finalizeDefaultXmls()
    {
        $this->zip->addFromString('[Content_Types].xml', DefaultXml::CONTENT_TYPES);
        $this->zip->addFromString('docProps/core.xml',
            sprintf(DefaultXml::DOCPROPS_CORE, date(DATE_ISO8601), date(DATE_ISO8601)));
        $this->zip->addFromString('docProps/app.xml', DefaultXml::DOCPROPS_APP);
        $this->zip->addFromString('_rels/.rels', DefaultXml::RELS_RELS);
        $this->zip->addFromString('xl/_rels/workbook.xml.rels', DefaultXml::XL_RELS_WORKBOOK);
        $this->zip->addFromString('xl/workbook.xml', DefaultXml::XL_WORKBOOK);
    }

    /**
     * Write zip/xlsx contents to specified output
     * and unlink/delete files.
     *
     * @param resource $output
     * @param string   $zipFileUrl
     */
    private function copyToOutputAndCleanup($output, $zipFileUrl)
    {
        $zipFilePointer = fopen($zipFileUrl, 'r');
        if (!stream_copy_to_stream($zipFilePointer, $output)
            || !fclose($zipFilePointer)
            || !fclose($output)
            || !unlink($zipFileUrl)
        ) {
            throw new \RuntimeException("Failed to copy stream and clean up!");
        }
    }
}