WorksheetManager::close() - Code Metrics - Inspection of "Row objects and Cell styling" - box/spout - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — develop_3.0 (#434)

by Hura

created 2017-06-01 16:25 UTC

WorksheetManager::close() A

↳ Parent: WorksheetManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2.0185

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	5
cts	6
cp	0.8333
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	1
crap	2.0185

<?php

namespace Box\Spout\Writer\ODS\Manager;

use Box\Spout\Common\Exception\InvalidArgumentException;
use Box\Spout\Common\Exception\IOException;
use Box\Spout\Common\Helper\StringHelper;
use Box\Spout\Writer\Common\Entity\Cell;
use Box\Spout\Writer\Common\Entity\Row;
use Box\Spout\Writer\Common\Entity\Worksheet;
use Box\Spout\Writer\Common\Manager\WorksheetManagerInterface;
use Box\Spout\Writer\ODS\Manager\Style\StyleManager;

/**
 * Class WorksheetManager
 * ODS worksheet manager, providing the interfaces to work with ODS worksheets.
 *
 * @package Box\Spout\Writer\ODS\Manager
 */
class WorksheetManager implements WorksheetManagerInterface
{
    /** @var \Box\Spout\Common\Escaper\ODS Strings escaper */
    private $stringsEscaper;

    /** @var StringHelper String helper */
    private $stringHelper;

    /** @var StyleManager Manages styles */
    private $styleManager;

    /**
     * WorksheetManager constructor.
     * @param StyleManager $styleManager
     * @param \Box\Spout\Common\Escaper\ODS $stringsEscaper
     * @param StringHelper $stringHelper
     */
    public function __construct(
        StyleManager $styleManager,
        \Box\Spout\Common\Escaper\ODS $stringsEscaper,
        StringHelper $stringHelper)
    {
        $this->stringsEscaper = $stringsEscaper;
        $this->stringHelper = $stringHelper;
        $this->styleManager = $styleManager;
    }

    /**
     * Prepares the worksheet to accept data
     *
     * @param Worksheet $worksheet The worksheet to start
     * @return void
     * @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
     */
    public function startSheet(Worksheet $worksheet)
    {
        $sheetFilePointer = fopen($worksheet->getFilePath(), 'w');
        $this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);

        $worksheet->setFilePointer($sheetFilePointer);
    }

    /**
     * Checks if the sheet has been sucessfully created. Throws an exception if not.
     *
     * @param bool|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
     * @return void
     * @throws IOException If the sheet data file cannot be opened for writing
     */
    private function throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)
    {
        if (!$sheetFilePointer) {
            throw new IOException('Unable to open sheet for writing.');
        }
    }

    /**
     * Returns the table XML root node as string.
     *
     * @param Worksheet $worksheet
     * @return string <table> node as string
     */
    public function getTableElementStartAsString(Worksheet $worksheet)
    {
        $externalSheet = $worksheet->getExternalSheet();
        $escapedSheetName = $this->stringsEscaper->escape($externalSheet->getName());
        $tableStyleName = 'ta' . ($externalSheet->getIndex() + 1);

        $tableElement  = '<table:table table:style-name="' . $tableStyleName . '" table:name="' . $escapedSheetName . '">';
        $tableElement .= '<table:table-column table:default-cell-style-name="ce1" table:style-name="co1" table:number-columns-repeated="' . $worksheet->getMaxNumColumns() . '"/>';

        return $tableElement;
    }

    /**
     * Adds a row to the worksheet.
     *
     * @param Worksheet $worksheet The worksheet to add the row to
     * @param Row $row The row to be added
     * @return void
     *
     * @throws IOException If the data cannot be written
     * @throws InvalidArgumentException If a cell value's type is not supported
     */
    public function addRow(Worksheet $worksheet, Row $row)
    {

        $cells = $row->getCells();
        $cellsCount = count($cells);

        $data = '<table:table-row table:style-name="ro1">';

        $currentCellIndex = 0;
        $nextCellIndex = 1;

        for ($i = 0; $i < $cellsCount; $i++) {

            /** @var Cell $cell */
            $cell = $cells[$currentCellIndex];
            /** @var Cell|null $nextCell */
            $nextCell = isset($cells[$nextCellIndex]) ? $cells[$nextCellIndex] : null;

            if (null === $nextCell || $cell->getValue() !== $nextCell->getValue()) {

                // Apply styles - the row style is merged at this point
                $cell->applyStyle($row->getStyle());
                $this->styleManager->applyExtraStylesIfNeeded($cell);
                $registeredStyle = $this->styleManager->registerStyle($cell->getStyle());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                $styleIndex = $registeredStyle->getId() + 1; // 1-based

                $numTimesValueRepeated = ($nextCellIndex - $currentCellIndex);
                $data .= $this->getCellXML($cell, $styleIndex, $numTimesValueRepeated);
                $currentCellIndex = $nextCellIndex;
            }

            $nextCellIndex++;
        }

        $data .= '</table:table-row>';

        $wasWriteSuccessful = fwrite($worksheet->getFilePointer(), $data);
        if ($wasWriteSuccessful === false) {
            throw new IOException("Unable to write data in {$worksheet->getFilePath()}");
        }

        // only update the count if the write worked
        $lastWrittenRowIndex = $worksheet->getLastWrittenRowIndex();
        $worksheet->setLastWrittenRowIndex($lastWrittenRowIndex + 1);
    }

    /**
     * Returns the cell XML content, given its value.
     *
     * @param Cell $cell The cell to be written
     * @param int $styleIndex Index of the used style
     * @param int $numTimesValueRepeated Number of times the value is consecutively repeated
     * @return string The cell XML content
     * @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
     */
    protected function getCellXML(Cell $cell, $styleIndex, $numTimesValueRepeated)
    {
        $data = '<table:table-cell table:style-name="ce' . $styleIndex . '"';

        if ($numTimesValueRepeated !== 1) {
            $data .= ' table:number-columns-repeated="' . $numTimesValueRepeated . '"';
        }

        if ($cell->isString()) {
            $data .= ' office:value-type="string" calcext:value-type="string">';

            $cellValueLines = explode("\n", $cell->getValue());
            foreach ($cellValueLines as $cellValueLine) {
                $data .= '<text:p>' . $this->stringsEscaper->escape($cellValueLine) . '</text:p>';
            }

            $data .= '</table:table-cell>';
        } else if ($cell->isBoolean()) {
            $data .= ' office:value-type="boolean" calcext:value-type="boolean" office:boolean-value="' . $cell->getValue() . '">';
            $data .= '<text:p>' . $cell->getValue() . '</text:p>';
            $data .= '</table:table-cell>';
        } else if ($cell->isNumeric()) {
            $data .= ' office:value-type="float" calcext:value-type="float" office:value="' . $cell->getValue() . '">';
            $data .= '<text:p>' . $cell->getValue() . '</text:p>';
            $data .= '</table:table-cell>';
        } else if ($cell->isEmpty()) {
            $data .= '/>';
        } else {
            throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . gettype($cell->getValue()));
        }

        return $data;
    }

    /**
     * Closes the worksheet
     *
     * @param Worksheet $worksheet
     * @return void
     */
    public function close(Worksheet $worksheet)
    {
        $worksheetFilePointer = $worksheet->getFilePointer();

        if (!is_resource($worksheetFilePointer)) {
            return;
        }

        fclose($worksheetFilePointer);
    }
}

1		<?php
2
3		namespace Box\Spout\Writer\ODS\Manager;
4
5		use Box\Spout\Common\Exception\InvalidArgumentException;
6		use Box\Spout\Common\Exception\IOException;
7		use Box\Spout\Common\Helper\StringHelper;
8		use Box\Spout\Writer\Common\Entity\Cell;
9		use Box\Spout\Writer\Common\Entity\Row;
10		use Box\Spout\Writer\Common\Entity\Worksheet;
11		use Box\Spout\Writer\Common\Manager\WorksheetManagerInterface;
12		use Box\Spout\Writer\ODS\Manager\Style\StyleManager;
13
14		/**
15		* Class WorksheetManager
16		* ODS worksheet manager, providing the interfaces to work with ODS worksheets.
17		*
18		* @package Box\Spout\Writer\ODS\Manager
19		*/
20		class WorksheetManager implements WorksheetManagerInterface
21		{
22		/** @var \Box\Spout\Common\Escaper\ODS Strings escaper */
23		private $stringsEscaper;
24
25		/** @var StringHelper String helper */
26		private $stringHelper;
27
28		/** @var StyleManager Manages styles */
29		private $styleManager;
30
31		/**
32		* WorksheetManager constructor.
33		* @param StyleManager $styleManager
34		* @param \Box\Spout\Common\Escaper\ODS $stringsEscaper
35		* @param StringHelper $stringHelper
36		*/
37	43	public function __construct(
38		StyleManager $styleManager,
39		\Box\Spout\Common\Escaper\ODS $stringsEscaper,
40		StringHelper $stringHelper)
41		{
42	43	$this->stringsEscaper = $stringsEscaper;
43	43	$this->stringHelper = $stringHelper;
44	43	$this->styleManager = $styleManager;
45	43	}
46
47		/**
48		* Prepares the worksheet to accept data
49		*
50		* @param Worksheet $worksheet The worksheet to start
51		* @return void
52		* @throws \Box\Spout\Common\Exception\IOException If the sheet data file cannot be opened for writing
53		*/
54	43	public function startSheet(Worksheet $worksheet)
55		{
56	43	$sheetFilePointer = fopen($worksheet->getFilePath(), 'w');
57	43	$this->throwIfSheetFilePointerIsNotAvailable($sheetFilePointer);
58
59	43	$worksheet->setFilePointer($sheetFilePointer);
60	43	}
61
62		/**
63		* Checks if the sheet has been sucessfully created. Throws an exception if not.
64		*
65		* @param bool\|resource $sheetFilePointer Pointer to the sheet data file or FALSE if unable to open the file
66		* @return void
67		* @throws IOException If the sheet data file cannot be opened for writing
68		*/
69	43	private function throwIfSheetFilePointerIsNotAvailable($sheetFilePointer)
70		{
71	43	if (!$sheetFilePointer) {
72		throw new IOException('Unable to open sheet for writing.');
73		}
74	43	}
75
76		/**
77		* Returns the table XML root node as string.
78		*
79		* @param Worksheet $worksheet
80		* @return string <table> node as string
81		*/
82	34	public function getTableElementStartAsString(Worksheet $worksheet)
83		{
84	34	$externalSheet = $worksheet->getExternalSheet();
85	34	$escapedSheetName = $this->stringsEscaper->escape($externalSheet->getName());
86	34	$tableStyleName = 'ta' . ($externalSheet->getIndex() + 1);
87
88	34	$tableElement = '<table:table table:style-name="' . $tableStyleName . '" table:name="' . $escapedSheetName . '">';
89	34	$tableElement .= '<table:table-column table:default-cell-style-name="ce1" table:style-name="co1" table:number-columns-repeated="' . $worksheet->getMaxNumColumns() . '"/>';
90
91	34	return $tableElement;
92		}
93
94		/**
95		* Adds a row to the worksheet.
96		*
97		* @param Worksheet $worksheet The worksheet to add the row to
98		* @param Row $row The row to be added
99		* @return void
100		*
101		* @throws IOException If the data cannot be written
102		* @throws InvalidArgumentException If a cell value's type is not supported
103		*/
104	31	public function addRow(Worksheet $worksheet, Row $row)
105		{
106
107	31	$cells = $row->getCells();
108	31	$cellsCount = count($cells);
109
110	31	$data = '<table:table-row table:style-name="ro1">';
111
112	31	$currentCellIndex = 0;
113	31	$nextCellIndex = 1;
114
115	31	for ($i = 0; $i < $cellsCount; $i++) {
116
117		/** @var Cell $cell */
118	31	$cell = $cells[$currentCellIndex];
119		/** @var Cell\|null $nextCell */
120	31	$nextCell = isset($cells[$nextCellIndex]) ? $cells[$nextCellIndex] : null;
121
122	31	if (null === $nextCell \|\| $cell->getValue() !== $nextCell->getValue()) {
123
124		// Apply styles - the row style is merged at this point
125	31	$cell->applyStyle($row->getStyle());
126	31	$this->styleManager->applyExtraStylesIfNeeded($cell);
127	31	$registeredStyle = $this->styleManager->registerStyle($cell->getStyle());
		0 ignored issues – show Bug introduced 2017-05-30 10:40 UTC by Report Bug Copy Issue Report It seems like `$cell->getStyle()` can be `null`; however, `registerStyle()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
128	31	$styleIndex = $registeredStyle->getId() + 1; // 1-based
129
130	31	$numTimesValueRepeated = ($nextCellIndex - $currentCellIndex);
131	31	$data .= $this->getCellXML($cell, $styleIndex, $numTimesValueRepeated);
132	30	$currentCellIndex = $nextCellIndex;
133		}
134
135	30	$nextCellIndex++;
136		}
137
138	30	$data .= '</table:table-row>';
139
140	30	$wasWriteSuccessful = fwrite($worksheet->getFilePointer(), $data);
141	30	if ($wasWriteSuccessful === false) {
142		throw new IOException("Unable to write data in {$worksheet->getFilePath()}");
143		}
144
145		// only update the count if the write worked
146	30	$lastWrittenRowIndex = $worksheet->getLastWrittenRowIndex();
147	30	$worksheet->setLastWrittenRowIndex($lastWrittenRowIndex + 1);
148	30	}
149
150		/**
151		* Returns the cell XML content, given its value.
152		*
153		* @param Cell $cell The cell to be written
154		* @param int $styleIndex Index of the used style
155		* @param int $numTimesValueRepeated Number of times the value is consecutively repeated
156		* @return string The cell XML content
157		* @throws \Box\Spout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
158		*/
159	31	protected function getCellXML(Cell $cell, $styleIndex, $numTimesValueRepeated)
160		{
161	31	$data = '<table:table-cell table:style-name="ce' . $styleIndex . '"';
162
163	31	if ($numTimesValueRepeated !== 1) {
164	4	$data .= ' table:number-columns-repeated="' . $numTimesValueRepeated . '"';
165		}
166
167	31	if ($cell->isString()) {
168	27	$data .= ' office:value-type="string" calcext:value-type="string">';
169
170	27	$cellValueLines = explode("\n", $cell->getValue());
171	27	foreach ($cellValueLines as $cellValueLine) {
172	27	$data .= '<text:p>' . $this->stringsEscaper->escape($cellValueLine) . '</text:p>';
173		}
174
175	27	$data .= '</table:table-cell>';
176	7	} else if ($cell->isBoolean()) {
177	3	$data .= ' office:value-type="boolean" calcext:value-type="boolean" office:boolean-value="' . $cell->getValue() . '">';
178	3	$data .= '<text:p>' . $cell->getValue() . '</text:p>';
179	3	$data .= '</table:table-cell>';
180	6	} else if ($cell->isNumeric()) {
181	3	$data .= ' office:value-type="float" calcext:value-type="float" office:value="' . $cell->getValue() . '">';
182	3	$data .= '<text:p>' . $cell->getValue() . '</text:p>';
183	3	$data .= '</table:table-cell>';
184	4	} else if ($cell->isEmpty()) {
185	2	$data .= '/>';
186		} else {
187	2	throw new InvalidArgumentException('Trying to add a value with an unsupported type: ' . gettype($cell->getValue()));
188		}
189
190	30	return $data;
191		}
192
193		/**
194		* Closes the worksheet
195		*
196		* @param Worksheet $worksheet
197		* @return void
198		*/
199	34	public function close(Worksheet $worksheet)
200		{
201	34	$worksheetFilePointer = $worksheet->getFilePointer();
202
203	34	if (!is_resource($worksheetFilePointer)) {
204		return;
205		}
206
207	34	fclose($worksheetFilePointer);
208		}
209		}

box / spout

Pull Request — develop_3.0 (#434)

WorksheetManager::close() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like