OneSheet\Finalizer

Complexity

Total Complexity

14

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

96.3%

Importance

Changes

0

8 Methods

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

<?php

namespace OneSheet;

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

class Finalizer
{
    /**
     * @var Sheet[]
     */
    private $sheets;

    /**
     * @var SheetFile[]
     */
    private $sheetFiles;

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

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

    /**
     * @var Workbook
     */
    private $workbook;

    /**
     * @param Workbook    $workbook
     * @param Sheet[]     $sheets
     * @param Styler      $styler
     * @param SheetFile[] $sheetFiles
     */
    public function __construct(array $sheets, Styler $styler, array $sheetFiles, Workbook $workbook)
    {
        $this->sheets = $sheets;
        $this->styler = $styler;
        $this->sheetFiles = $sheetFiles;
        $this->workbook = $workbook;
        $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);
        foreach ($this->sheets as $sheetName => $sheet) {
            $this->finalizeSheet($this->sheetFiles[$sheetName], $sheet, $sheetName);
        }
        $this->finalizeWorkbook(array_keys($this->sheets));
        $this->finalizeStyles();
        $this->finalizeDefaultXmls();
    }

    /**
     * @param SheetFile $sheetFile
     * @param Sheet     $sheet
     * @param string    $sheetName
     */
    private function finalizeSheet($sheetFile, $sheet, $sheetName)
    {
        $sheetFile->fwrite('</sheetData></worksheet>');
        $sheetFile->rewind();
        $sheetFile->fwrite(SheetXml::HEADER_XML);
        $sheetFile->fwrite($sheet->getDimensionXml());
        $sheetFile->fwrite($sheet->getSheetViewsXml());
        $sheetFile->fwrite($sheet->getColsXml());
        $this->zip->addFile($sheetFile->getFilePath(),
            sprintf("xl/worksheets/%s.xml", $sheetName));
    }

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

    /**
     * Write workbook file.
     * @param string[] $sheetNames
     */
    private function finalizeWorkbook(array $sheetNames)
    {
        $this->zip->addFromString('xl/workbook.xml', $this->workbook->getWorkbookXml($sheetNames));
        $this->zip->addFromString('xl/_rels/workbook.xml.rels', $this->workbook->getWorkbookRelsXml($sheetNames));
    }

    /**
     * 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_W3C), date(DATE_W3C)));
        $this->zip->addFromString('docProps/app.xml', DefaultXml::DOCPROPS_APP);
        $this->zip->addFromString('_rels/.rels', DefaultXml::RELS_RELS);
    }

    /**
     * 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!");
        }
    }
}