OneSheet\Writer

Complexity

Total Complexity

23

Size/Duplication

Total Lines	226
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

87.72%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setFreezePaneCellId()	0	4	1
A	setPrintTitleRange()	0	4	1
A	setFixedColumnWidths()	0	4	1
A	setColumnWidthLimits()	0	4	1
A	enableCellAutosizing()	0	5	1
A	disableCellAutosizing()	0	5	1
A	addRows()	0	10	4
A	addRow()	0	10	3
A	switchSheet()	0	6	3
A	writeToFile()	0	6	1
A	writeToBrowser()	0	7	1
A	sendHeaders()	0	9	2
A	getFonts()	0	4	1
A	createNewSheet()	0	6	1

<?php

namespace OneSheet;

use OneSheet\Size\SizeCalculator;
use OneSheet\Style\Style;
use OneSheet\Style\Styler;

class Writer
{
    /**
     * @var SheetFile[]
     */
    private $sheetFiles;

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

    /**
     * @var Sheet[]
     */
    private $sheets;

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

    /**
     * @var resource
     */
    private $output;

    /**
     * @var string|int
     */
    private $currentSheet;

    /**
     * If a $fontsDirectory is supplied it will be scanned for usable ttf/otf fonts
     * to be used for cell auto-sizing. Keep in mind though - viewers of an excel
     * file have to have that font on their machine. XLSX does not embed fonts!
     *
     * @param string|null $fontsDirectory
     * @param int         $sheetId
     * @throws \Exception
     */
    public function __construct($fontsDirectory = null, $sheetId = 1)
    {
        $this->styler = new Styler();
        $this->switchSheet($sheetId, $fontsDirectory);
        $this->workbook = new Workbook();
    }

    /**
     * All cells _above_ this cell (e.g. A2) will be frozen/fixed.
     *
     * @param string $cellId
     */
    public function setFreezePaneCellId($cellId)
    {
        $this->sheets[$this->currentSheet]->setFreezePaneCellId($cellId);
    }

    /**
     * Set the range of rows to repeat at the top of each page when printing the
     * excel file. $startRow=1 and $endRow=1 will repeat the first row only.
     *
     * @param int $startRow
     * @param int $endRow
     */
    public function setPrintTitleRange($startRow, $endRow)
    {
        $this->workbook->setPrintTitleRange($startRow, $endRow);
    }

    /**
     * Set fixed column widths per cell (no ranges) and array index
     * 0 being the first column.
     * If used alongside cell autosizing, these should be set
     * after the last row has been added.
     *
     * @param array $columnWidths
     * @throws \InvalidArgumentException
     */
    public function setFixedColumnWidths(array $columnWidths)
    {
        $this->sheets[$this->currentSheet]->setFixedColumnWidths($columnWidths);
    }

    /**
     * Set lower and/or upper limits for column widths.
     *
     * @param int|float|null $minWidth
     * @param int|float|null $maxWidth
     */
    public function setColumnWidthLimits($minWidth = null, $maxWidth = null)
    {
        $this->sheets[$this->currentSheet]->setColumnWidthLimits($minWidth, $maxWidth);
    }

    /**
     * Start recording row specs for column auto-sizing.
     *
     * @return Writer
     */
    public function enableCellAutosizing()
    {
        $this->sheets[$this->currentSheet]->enableCellAutosizing();
        return $this;
    }

    /**
     * Stop recording row specs for column autosizing.
     *
     * @return Writer
     */
    public function disableCellAutosizing()
    {
        $this->sheets[$this->currentSheet]->disableCellAutosizing();
        return $this;
    }

    /**
     * Add multiple rows at once.
     *
     * @param array|\Traversable $rows
     * @param Style              $style
     * @throws \InvalidArgumentException
     */
    public function addRows($rows, Style $style = null)
    {
        if (!is_array($rows) && false === $rows instanceof \Traversable) {
            throw new \InvalidArgumentException('Expected array or traversable object as rows');
        }

        foreach ($rows as $row) {
            $this->addRow($row, $style);
        }
    }

    /**
     * Add a single new row to the sheet and supply an optional style.
     *
     * @param array $row
     * @param Style $style
     */
    public function addRow(array $row, Style $style = null)
    {
        if (!empty($row)) {
            $style = $style instanceof Style ? $style : $this->styler->getDefaultStyle();
            $this->styler->addStyle($style);
            $this->sheetFiles[$this->currentSheet]->fwrite(
                $this->sheets[$this->currentSheet]->addRow($row, $style)
            );
        }
    }

    /**
     * @param string|int  $sheetId
     * @param string|null $fontsDirectory
     * @throws \Exception
     */
    public function switchSheet($sheetId, $fontsDirectory = null)
    {
        $sheetId = is_int($sheetId) ? "Sheet{$sheetId}" : $sheetId;
        isset($this->sheets[$sheetId]) || $this->createNewSheet($fontsDirectory, $sheetId);
        $this->currentSheet = $sheetId;
    }

    /**
     * Wrap things up and write xlsx.
     *
     * @param string $fileName
     */
    public function writeToFile($fileName = 'report.xlsx')
    {
        $this->output = fopen($fileName, 'w');
        $finalizer = new Finalizer($this->sheets, $this->styler, $this->sheetFiles, $this->workbook);
        $finalizer->finalize($this->output);
    }

    /**
     * Wrap things up and send xlsx to browser.
     *
     * @param string $fileName
     */
    public function writeToBrowser($fileName = 'report.xlsx')
    {
        $this->output = fopen('php://output', 'w');
        $finalizer = new Finalizer($this->sheets, $this->styler, $this->sheetFiles, $this->workbook);
        $this->sendHeaders($fileName);
        $finalizer->finalize($this->output);
    }

    /**
     * Send headers for browser output.
     *
     * @param string $fileName
     */
    private function sendHeaders($fileName)
    {
        if (!headers_sent()) {
            header('Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
            header('Content-Disposition: attachment; filename="' . $fileName . '"');
            header('Cache-Control: max-age=0');
            header('Pragma: public');
        }
    }

    /**
     * Return array of available fonts & paths as key value pairs.
     *
     * @return array
     */
    public function getFonts()
    {
        return $this->sheets[$this->currentSheet]->getFonts();
    }

    /**
     * @param string $fontsDirectory
     * @param int    $sheetId
     * @throws \Exception
     */
    private function createNewSheet($fontsDirectory, $sheetId)
    {
        $this->sheetFiles[$sheetId] = new SheetFile();
        $this->sheetFiles[$sheetId]->fwrite(str_repeat(' ', 1024 * 1024) . '<sheetData>');
        $this->sheets[$sheetId] = new Sheet(new CellBuilder(), new SizeCalculator($fontsDirectory));
    }
}