OneSheet\Sheet

Complexity

Total Complexity

31

Size/Duplication

Total Lines	239
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Test Coverage

Coverage

91.67%

Importance

Changes	17
Bugs	5	Features	5

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	enableCellAutosizing()	0	4	1
A	disableCellAutosizing()	0	4	1
A	setFreezePaneCellId()	0	4	1
A	setFixedColumnWidths()	0	10	3
A	setColumnWidthBoundries()	0	5	3
B	getColumnWidths()	0	10	5
A	getDimensionUpperBound()	0	4	1
A	addRow()	0	15	3
A	updateMaxColumnCount()	0	6	2
A	getCellXml()	0	12	3
A	updateColumnWidths()	0	11	4
A	getFreezePaneXml()	0	9	3

<?php

namespace OneSheet;

use OneSheet\Xml\RowXml;
use OneSheet\Style\Style;
use OneSheet\Xml\SheetXml;
use OneSheet\Width\WidthCalculator;

/**
 * Class Sheet
 *
 * @package OneSheet
 */
class Sheet
{
    /**
     * @var CellBuilder
     */
    private $cellBuilder;

    /**
     * @var WidthCalculator
     */
    private $widthCalculator;

    /**
     * @var bool
     */
    private $useCellAutosizing = false;

    /**
     * @var int
     */
    private $freezePaneCellId;

    /**
     * Track next row index.
     *
     * @var int
     */
    private $rowIndex = 1;

    /**
     * Holds width/column count of the widest row.
     *
     * @var int
     */
    private $maxColumnCount;

    /**
     * Holds widths of the widest cells for column sizing.
     *
     * @var array
     */
    private $columnWidths = array();

    /**
     * Holds minimum allowed column width.
     *
     * @var array
     */
    private $minColumnWidth;

    /**
     * Holds maximum allowed column width.
     *
     * @var array
     */
    private $maxColumnWidth;

    /**
     * Sheet constructor.
     *
     * @param CellBuilder     $cellBuilder
     * @param WidthCalculator $widthCalculator
     */
    public function __construct(CellBuilder $cellBuilder, WidthCalculator $widthCalculator)
    {
        $this->cellBuilder = $cellBuilder;
        $this->widthCalculator = $widthCalculator;
    }

    /**
     * Enable cell autosizing (~30% performance hit!).
     */
    public function enableCellAutosizing()
    {
        $this->useCellAutosizing = true;
    }

    /**
     * Disable cell autosizing (default).
     */
    public function disableCellAutosizing()
    {
        $this->useCellAutosizing = false;
    }

    /**
     * @param int $cellId
     */
    public function setFreezePaneCellId($cellId)
    {
        $this->freezePaneCellId = $cellId;
    }

    /**
     * Set custom column widths with 0 representing the first column.
     *
     * @param array $columnWidths
     * @throws \InvalidArgumentException
     */
    public function setFixedColumnWidths(array $columnWidths)
    {
        if ($columnWidths !== array_filter($columnWidths, 'is_numeric')
            || array_keys($columnWidths) !== array_filter(array_keys($columnWidths), 'is_int')
        ) {
            throw new \InvalidArgumentException('Array must contain integer keys and numeric values only!');
        }

        $this->columnWidths = $columnWidths + $this->columnWidths;
    }

    /**
     * Set lower and/or upper limits for column widths.
     *
     * @param float|null $minWidth
     * @param float|null $maxWidth
     */
    public function setColumnWidthBoundries($minWidth = null, $maxWidth = null)
    {
        $this->minColumnWidth = $minWidth ?: null;

It seems like $minWidth ?: null of type double or null is incompatible with the declared type array of property $minColumnWidth.

        $this->maxColumnWidth = $maxWidth ?: null;

It seems like $maxWidth ?: null of type double or null is incompatible with the declared type array of property $maxColumnWidth.

    }

    /**
     * Return array containing all column widths, limited to min or max
     * column width, if one or both of them are set.
     *
     * @return array
     */
    public function getColumnWidths()
    {
        return array_map(function ($width) {
            if ($this->maxColumnWidth && $this->maxColumnWidth < $width) {

The expression $this->maxColumnWidth of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                return $this->maxColumnWidth;
            } elseif ($this->minColumnWidth && $this->minColumnWidth > $width) {

The expression $this->minColumnWidth of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                return $this->minColumnWidth;
            } return $width;
        }, $this->columnWidths);
    }

    /**
     * Return cellId for dimensions.
     *
     * @return string
     */
    public function getDimensionUpperBound()
    {
        return $this->cellBuilder->getCellId($this->maxColumnCount, $this->rowIndex - 1);
    }

    /**
     * Add single row and style to sheet.
     *
     * @param array $row
     * @param Style $style
     *
     * @return string
     */
    public function addRow(array $row, Style $style)
    {
        $columnCount = count($row);
        $this->updateMaxColumnCount($columnCount);

        $this->widthCalculator->setFont($style->getFont());
        $cellXml = $this->getCellXml($row, $style);

        if (!$this->useCellAutosizing || $style->getFont()->getSize() < 14) {
            return sprintf(RowXml::DEFAULT_XML, $this->rowIndex++, $columnCount, $cellXml);
        }

        return sprintf(RowXml::HEIGHT_XML, $this->rowIndex++, $columnCount,
            $style->getFont()->getSize() * 1.4, $cellXml);
    }

    /**
     * Track column count for dimensions xml (e.g. A1:K123).
     *
     * @param int $columnCount
     */
    private function updateMaxColumnCount($columnCount)
    {
        if ($this->maxColumnCount < $columnCount) {
            $this->maxColumnCount = $columnCount;
        }
    }

    /**
     * Get xml string for single cell and update cell widths.
     *
     * @param array $row
     * @param Style $style
     * @return string
     */
    private function getCellXml(array $row, Style $style)
    {
        $cellXml = '';
        foreach (array_values($row) as $cellIndex => $cellValue) {
            if (0 < strlen($cellValue)) {
                $this->updateColumnWidths($cellValue, $cellIndex, $style);
                $cellXml .= $this->cellBuilder->build($this->rowIndex, $cellIndex, $cellValue, $style->getId());
            }
        }

        return $cellXml;
    }

    /**
     * Track cell width for column width sizing if its enabled.
     *
     * @param mixed $value
     * @param int   $cellIndex
     * @param Style $style
     */
    private function updateColumnWidths($value, $cellIndex, Style $style)
    {
        if ($this->useCellAutosizing) {
            $cellWidth = $this->widthCalculator->getCellWidth($value, $style->getFont());
            if (!isset($this->columnWidths[$cellIndex])
                || $this->columnWidths[$cellIndex] < $cellWidth
            ) {
                $this->columnWidths[$cellIndex] = $cellWidth;
            }
        }
    }

    /**
     * Return freeze pane xml string for sheetView.
     *
     * @return string
     */
    public function getFreezePaneXml()
    {
        if (!$this->freezePaneCellId
            || 1 !== preg_match('~^[A-Z]+(\d+)$~', $this->freezePaneCellId, $m)
        ) {
            return '';
        }
        return sprintf(SheetXml::FREEZE_PANE_XML, array_pop($m) - 1, $this->freezePaneCellId);
    }
}