Workbook::writeWorkbookPr() - Code Metrics - Inspection of "Support PHP 7.2" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( c96e2d...d2f55f )

by Adrien

created 2018-01-28 07:24 UTC

Workbook::writeWorkbookPr() A

↳ Parent: Workbook

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2.0185

Importance

Changes

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

<?php

namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;

use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\NamedRange;
use PhpOffice\PhpSpreadsheet\Shared\Date;
use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException;

class Workbook extends WriterPart
{
    /**
     * Write workbook to XML format.
     *
     * @param Spreadsheet $spreadsheet
     * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing
     *
     * @throws WriterException
     *
     * @return string XML Output
     */
    public function writeWorkbook(Spreadsheet $spreadsheet, $recalcRequired = false)
    {
        // Create XML writer
        if ($this->getParentWriter()->getUseDiskCaching()) {
            $objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
        } else {
            $objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
        }

        // XML header
        $objWriter->startDocument('1.0', 'UTF-8', 'yes');

        // workbook
        $objWriter->startElement('workbook');
        $objWriter->writeAttribute('xml:space', 'preserve');
        $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/spreadsheetml/2006/main');
        $objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships');

        // fileVersion
        $this->writeFileVersion($objWriter);

        // workbookPr
        $this->writeWorkbookPr($objWriter);

        // workbookProtection
        $this->writeWorkbookProtection($objWriter, $spreadsheet);

        // bookViews
        if ($this->getParentWriter()->getOffice2003Compatibility() === false) {
            $this->writeBookViews($objWriter, $spreadsheet);
        }

        // sheets
        $this->writeSheets($objWriter, $spreadsheet);

        // definedNames
        $this->writeDefinedNames($objWriter, $spreadsheet);

        // calcPr
        $this->writeCalcPr($objWriter, $recalcRequired);

        $objWriter->endElement();

        // Return
        return $objWriter->getData();
    }

    /**
     * Write file version.
     *
     * @param XMLWriter $objWriter XML Writer
     */
    private function writeFileVersion(XMLWriter $objWriter)
    {
        $objWriter->startElement('fileVersion');
        $objWriter->writeAttribute('appName', 'xl');
        $objWriter->writeAttribute('lastEdited', '4');
        $objWriter->writeAttribute('lowestEdited', '4');
        $objWriter->writeAttribute('rupBuild', '4505');
        $objWriter->endElement();
    }

    /**
     * Write WorkbookPr.
     *
     * @param XMLWriter $objWriter XML Writer
     */
    private function writeWorkbookPr(XMLWriter $objWriter)
    {
        $objWriter->startElement('workbookPr');

        if (Date::getExcelCalendar() == Date::CALENDAR_MAC_1904) {
            $objWriter->writeAttribute('date1904', '1');
        }

        $objWriter->writeAttribute('codeName', 'ThisWorkbook');

        $objWriter->endElement();
    }

    /**
     * Write BookViews.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param Spreadsheet $spreadsheet
     */
    private function writeBookViews(XMLWriter $objWriter, Spreadsheet $spreadsheet)
    {
        // bookViews
        $objWriter->startElement('bookViews');

        // workbookView
        $objWriter->startElement('workbookView');

        $objWriter->writeAttribute('activeTab', $spreadsheet->getActiveSheetIndex());
        $objWriter->writeAttribute('autoFilterDateGrouping', '1');
        $objWriter->writeAttribute('firstSheet', '0');
        $objWriter->writeAttribute('minimized', '0');
        $objWriter->writeAttribute('showHorizontalScroll', '1');
        $objWriter->writeAttribute('showSheetTabs', '1');
        $objWriter->writeAttribute('showVerticalScroll', '1');
        $objWriter->writeAttribute('tabRatio', '600');
        $objWriter->writeAttribute('visibility', 'visible');

        $objWriter->endElement();

        $objWriter->endElement();
    }

    /**
     * Write WorkbookProtection.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param Spreadsheet $spreadsheet
     */
    private function writeWorkbookProtection(XMLWriter $objWriter, Spreadsheet $spreadsheet)
    {
        if ($spreadsheet->getSecurity()->isSecurityEnabled()) {
            $objWriter->startElement('workbookProtection');
            $objWriter->writeAttribute('lockRevision', ($spreadsheet->getSecurity()->getLockRevision() ? 'true' : 'false'));
            $objWriter->writeAttribute('lockStructure', ($spreadsheet->getSecurity()->getLockStructure() ? 'true' : 'false'));
            $objWriter->writeAttribute('lockWindows', ($spreadsheet->getSecurity()->getLockWindows() ? 'true' : 'false'));

            if ($spreadsheet->getSecurity()->getRevisionsPassword() != '') {
                $objWriter->writeAttribute('revisionsPassword', $spreadsheet->getSecurity()->getRevisionsPassword());
            }

            if ($spreadsheet->getSecurity()->getWorkbookPassword() != '') {
                $objWriter->writeAttribute('workbookPassword', $spreadsheet->getSecurity()->getWorkbookPassword());
            }

            $objWriter->endElement();
        }
    }

    /**
     * Write calcPr.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing
     */
    private function writeCalcPr(XMLWriter $objWriter, $recalcRequired = true)
    {
        $objWriter->startElement('calcPr');

        //    Set the calcid to a higher value than Excel itself will use, otherwise Excel will always recalc
        //  If MS Excel does do a recalc, then users opening a file in MS Excel will be prompted to save on exit
        //     because the file has changed
        $objWriter->writeAttribute('calcId', '999999');
        $objWriter->writeAttribute('calcMode', 'auto');
        //    fullCalcOnLoad isn't needed if we've recalculating for the save
        $objWriter->writeAttribute('calcCompleted', ($recalcRequired) ? 1 : 0);
        $objWriter->writeAttribute('fullCalcOnLoad', ($recalcRequired) ? 0 : 1);

        $objWriter->endElement();
    }

    /**
     * Write sheets.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param Spreadsheet $spreadsheet
     *
     * @throws WriterException
     */
    private function writeSheets(XMLWriter $objWriter, Spreadsheet $spreadsheet)
    {
        // Write sheets
        $objWriter->startElement('sheets');
        $sheetCount = $spreadsheet->getSheetCount();
        for ($i = 0; $i < $sheetCount; ++$i) {
            // sheet
            $this->writeSheet(
                $objWriter,
                $spreadsheet->getSheet($i)->getTitle(),
                ($i + 1),
                ($i + 1 + 3),
                $spreadsheet->getSheet($i)->getSheetState()
            );
        }

        $objWriter->endElement();
    }

    /**
     * Write sheet.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param string $pSheetname Sheet name
     * @param int $pSheetId Sheet id
     * @param int $pRelId Relationship ID
     * @param string $sheetState Sheet state (visible, hidden, veryHidden)
     *
     * @throws WriterException
     */
    private function writeSheet(XMLWriter $objWriter, $pSheetname, $pSheetId = 1, $pRelId = 1, $sheetState = 'visible')
    {
        if ($pSheetname != '') {
            // Write sheet
            $objWriter->startElement('sheet');
            $objWriter->writeAttribute('name', $pSheetname);
            $objWriter->writeAttribute('sheetId', $pSheetId);
            if ($sheetState != 'visible' && $sheetState != '') {
                $objWriter->writeAttribute('state', $sheetState);
            }
            $objWriter->writeAttribute('r:id', 'rId' . $pRelId);
            $objWriter->endElement();
        } else {
            throw new WriterException('Invalid parameters passed.');
        }
    }

    /**
     * Write Defined Names.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param Spreadsheet $spreadsheet
     *
     * @throws WriterException
     */
    private function writeDefinedNames(XMLWriter $objWriter, Spreadsheet $spreadsheet)
    {
        // Write defined names
        $objWriter->startElement('definedNames');

        // Named ranges
        if (count($spreadsheet->getNamedRanges()) > 0) {
            // Named ranges
            $this->writeNamedRanges($objWriter, $spreadsheet);
        }

        // Other defined names
        $sheetCount = $spreadsheet->getSheetCount();
        for ($i = 0; $i < $sheetCount; ++$i) {
            // definedName for autoFilter
            $this->writeDefinedNameForAutofilter($objWriter, $spreadsheet->getSheet($i), $i);

            // definedName for Print_Titles
            $this->writeDefinedNameForPrintTitles($objWriter, $spreadsheet->getSheet($i), $i);

            // definedName for Print_Area
            $this->writeDefinedNameForPrintArea($objWriter, $spreadsheet->getSheet($i), $i);
        }

        $objWriter->endElement();
    }

    /**
     * Write named ranges.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param Spreadsheet $spreadsheet
     *
     * @throws WriterException
     */
    private function writeNamedRanges(XMLWriter $objWriter, Spreadsheet $spreadsheet)
    {
        // Loop named ranges
        $namedRanges = $spreadsheet->getNamedRanges();
        foreach ($namedRanges as $namedRange) {
            $this->writeDefinedNameForNamedRange($objWriter, $namedRange);
        }
    }

    /**
     * Write Defined Name for named range.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param NamedRange $pNamedRange
     */
    private function writeDefinedNameForNamedRange(XMLWriter $objWriter, NamedRange $pNamedRange)
    {
        // definedName for named range
        $objWriter->startElement('definedName');
        $objWriter->writeAttribute('name', $pNamedRange->getName());
        if ($pNamedRange->getLocalOnly()) {
            $objWriter->writeAttribute('localSheetId', $pNamedRange->getScope()->getParent()->getIndex($pNamedRange->getScope()));
        }

        // Create absolute coordinate and write as raw text
        $range = Coordinate::splitRange($pNamedRange->getRange());
        $iMax = count($range);
        for ($i = 0; $i < $iMax; ++$i) {
            $range[$i][0] = '\'' . str_replace("'", "''", $pNamedRange->getWorksheet()->getTitle()) . '\'!' . Coordinate::absoluteReference($range[$i][0]);
            if (isset($range[$i][1])) {
                $range[$i][1] = Coordinate::absoluteReference($range[$i][1]);
            }
        }
        $range = Coordinate::buildRange($range);

        $objWriter->writeRawData($range);

        $objWriter->endElement();
    }

    /**
     * Write Defined Name for autoFilter.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param Worksheet $pSheet
     * @param int $pSheetId
     */
    private function writeDefinedNameForAutofilter(XMLWriter $objWriter, Worksheet $pSheet, $pSheetId = 0)
    {
        // definedName for autoFilter
        $autoFilterRange = $pSheet->getAutoFilter()->getRange();
        if (!empty($autoFilterRange)) {
            $objWriter->startElement('definedName');
            $objWriter->writeAttribute('name', '_xlnm._FilterDatabase');
            $objWriter->writeAttribute('localSheetId', $pSheetId);
            $objWriter->writeAttribute('hidden', '1');

            // Create absolute coordinate and write as raw text
            $range = Coordinate::splitRange($autoFilterRange);
            $range = $range[0];
            //    Strip any worksheet ref so we can make the cell ref absolute
            if (strpos($range[0], '!') !== false) {
                list($ws, $range[0]) = explode('!', $range[0]);
            }

            $range[0] = Coordinate::absoluteCoordinate($range[0]);
            $range[1] = Coordinate::absoluteCoordinate($range[1]);
            $range = implode(':', $range);

            $objWriter->writeRawData('\'' . str_replace("'", "''", $pSheet->getTitle()) . '\'!' . $range);

            $objWriter->endElement();
        }
    }

    /**
     * Write Defined Name for PrintTitles.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param Worksheet $pSheet
     * @param int $pSheetId
     */
    private function writeDefinedNameForPrintTitles(XMLWriter $objWriter, Worksheet $pSheet, $pSheetId = 0)
    {
        // definedName for PrintTitles
        if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet() || $pSheet->getPageSetup()->isRowsToRepeatAtTopSet()) {
            $objWriter->startElement('definedName');
            $objWriter->writeAttribute('name', '_xlnm.Print_Titles');
            $objWriter->writeAttribute('localSheetId', $pSheetId);

            // Setting string
            $settingString = '';

            // Columns to repeat
            if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet()) {
                $repeat = $pSheet->getPageSetup()->getColumnsToRepeatAtLeft();

                $settingString .= '\'' . str_replace("'", "''", $pSheet->getTitle()) . '\'!$' . $repeat[0] . ':$' . $repeat[1];
            }

            // Rows to repeat
            if ($pSheet->getPageSetup()->isRowsToRepeatAtTopSet()) {
                if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet()) {
                    $settingString .= ',';
                }

                $repeat = $pSheet->getPageSetup()->getRowsToRepeatAtTop();

                $settingString .= '\'' . str_replace("'", "''", $pSheet->getTitle()) . '\'!$' . $repeat[0] . ':$' . $repeat[1];
            }

            $objWriter->writeRawData($settingString);

            $objWriter->endElement();
        }
    }

    /**
     * Write Defined Name for PrintTitles.
     *
     * @param XMLWriter $objWriter XML Writer
     * @param Worksheet $pSheet
     * @param int $pSheetId
     */
    private function writeDefinedNameForPrintArea(XMLWriter $objWriter, Worksheet $pSheet, $pSheetId = 0)
    {
        // definedName for PrintArea
        if ($pSheet->getPageSetup()->isPrintAreaSet()) {
            $objWriter->startElement('definedName');
            $objWriter->writeAttribute('name', '_xlnm.Print_Area');
            $objWriter->writeAttribute('localSheetId', $pSheetId);

            // Print area
            $printArea = Coordinate::splitRange($pSheet->getPageSetup()->getPrintArea());

            $chunks = [];
            foreach ($printArea as $printAreaRect) {
                $printAreaRect[0] = Coordinate::absoluteReference($printAreaRect[0]);
                $printAreaRect[1] = Coordinate::absoluteReference($printAreaRect[1]);
                $chunks[] = '\'' . str_replace("'", "''", $pSheet->getTitle()) . '\'!' . implode(':', $printAreaRect);
            }

            $objWriter->writeRawData(implode(',', $chunks));

            $objWriter->endElement();
        }
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;
4
5		use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
6		use PhpOffice\PhpSpreadsheet\NamedRange;
7		use PhpOffice\PhpSpreadsheet\Shared\Date;
8		use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
9		use PhpOffice\PhpSpreadsheet\Spreadsheet;
10		use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
		0 ignored issues – show Bug introduced 2017-12-03 09:09 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `PhpOffice\PhpSpreadsheet\Writer\Xlsx\Worksheet`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
11		use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException;
12
13		class Workbook extends WriterPart
14		{
15		/**
16		* Write workbook to XML format.
17		*
18		* @param Spreadsheet $spreadsheet
19		* @param bool $recalcRequired Indicate whether formulas should be recalculated before writing
20		*
21		* @throws WriterException
22		*
23		* @return string XML Output
24		*/
25	60	public function writeWorkbook(Spreadsheet $spreadsheet, $recalcRequired = false)
26		{
27		// Create XML writer
28	60	if ($this->getParentWriter()->getUseDiskCaching()) {
29		$objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
30		} else {
31	60	$objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
32		}
33
34		// XML header
35	60	$objWriter->startDocument('1.0', 'UTF-8', 'yes');
36
37		// workbook
38	60	$objWriter->startElement('workbook');
39	60	$objWriter->writeAttribute('xml:space', 'preserve');
40	60	$objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/spreadsheetml/2006/main');
41	60	$objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships');
42
43		// fileVersion
44	60	$this->writeFileVersion($objWriter);
45
46		// workbookPr
47	60	$this->writeWorkbookPr($objWriter);
48
49		// workbookProtection
50	60	$this->writeWorkbookProtection($objWriter, $spreadsheet);
51
52		// bookViews
53	60	if ($this->getParentWriter()->getOffice2003Compatibility() === false) {
54	60	$this->writeBookViews($objWriter, $spreadsheet);
55		}
56
57		// sheets
58	60	$this->writeSheets($objWriter, $spreadsheet);
59
60		// definedNames
61	60	$this->writeDefinedNames($objWriter, $spreadsheet);
62
63		// calcPr
64	60	$this->writeCalcPr($objWriter, $recalcRequired);
65
66	60	$objWriter->endElement();
67
68		// Return
69	60	return $objWriter->getData();
70		}
71
72		/**
73		* Write file version.
74		*
75		* @param XMLWriter $objWriter XML Writer
76		*/
77	60	private function writeFileVersion(XMLWriter $objWriter)
78		{
79	60	$objWriter->startElement('fileVersion');
80	60	$objWriter->writeAttribute('appName', 'xl');
81	60	$objWriter->writeAttribute('lastEdited', '4');
82	60	$objWriter->writeAttribute('lowestEdited', '4');
83	60	$objWriter->writeAttribute('rupBuild', '4505');
84	60	$objWriter->endElement();
85	60	}
86
87		/**
88		* Write WorkbookPr.
89		*
90		* @param XMLWriter $objWriter XML Writer
91		*/
92	60	private function writeWorkbookPr(XMLWriter $objWriter)
93		{
94	60	$objWriter->startElement('workbookPr');
95
96	60	if (Date::getExcelCalendar() == Date::CALENDAR_MAC_1904) {
97		$objWriter->writeAttribute('date1904', '1');
98		}
99
100	60	$objWriter->writeAttribute('codeName', 'ThisWorkbook');
101
102	60	$objWriter->endElement();
103	60	}
104
105		/**
106		* Write BookViews.
107		*
108		* @param XMLWriter $objWriter XML Writer
109		* @param Spreadsheet $spreadsheet
110		*/
111	60	private function writeBookViews(XMLWriter $objWriter, Spreadsheet $spreadsheet)
112		{
113		// bookViews
114	60	$objWriter->startElement('bookViews');
115
116		// workbookView
117	60	$objWriter->startElement('workbookView');
118
119	60	$objWriter->writeAttribute('activeTab', $spreadsheet->getActiveSheetIndex());
120	60	$objWriter->writeAttribute('autoFilterDateGrouping', '1');
121	60	$objWriter->writeAttribute('firstSheet', '0');
122	60	$objWriter->writeAttribute('minimized', '0');
123	60	$objWriter->writeAttribute('showHorizontalScroll', '1');
124	60	$objWriter->writeAttribute('showSheetTabs', '1');
125	60	$objWriter->writeAttribute('showVerticalScroll', '1');
126	60	$objWriter->writeAttribute('tabRatio', '600');
127	60	$objWriter->writeAttribute('visibility', 'visible');
128
129	60	$objWriter->endElement();
130
131	60	$objWriter->endElement();
132	60	}
133
134		/**
135		* Write WorkbookProtection.
136		*
137		* @param XMLWriter $objWriter XML Writer
138		* @param Spreadsheet $spreadsheet
139		*/
140	60	private function writeWorkbookProtection(XMLWriter $objWriter, Spreadsheet $spreadsheet)
141		{
142	60	if ($spreadsheet->getSecurity()->isSecurityEnabled()) {
143	2	$objWriter->startElement('workbookProtection');
144	2	$objWriter->writeAttribute('lockRevision', ($spreadsheet->getSecurity()->getLockRevision() ? 'true' : 'false'));
145	2	$objWriter->writeAttribute('lockStructure', ($spreadsheet->getSecurity()->getLockStructure() ? 'true' : 'false'));
146	2	$objWriter->writeAttribute('lockWindows', ($spreadsheet->getSecurity()->getLockWindows() ? 'true' : 'false'));
147
148	2	if ($spreadsheet->getSecurity()->getRevisionsPassword() != '') {
149		$objWriter->writeAttribute('revisionsPassword', $spreadsheet->getSecurity()->getRevisionsPassword());
150		}
151
152	2	if ($spreadsheet->getSecurity()->getWorkbookPassword() != '') {
153	2	$objWriter->writeAttribute('workbookPassword', $spreadsheet->getSecurity()->getWorkbookPassword());
154		}
155
156	2	$objWriter->endElement();
157		}
158	60	}
159
160		/**
161		* Write calcPr.
162		*
163		* @param XMLWriter $objWriter XML Writer
164		* @param bool $recalcRequired Indicate whether formulas should be recalculated before writing
165		*/
166	60	private function writeCalcPr(XMLWriter $objWriter, $recalcRequired = true)
167		{
168	60	$objWriter->startElement('calcPr');
169
170		// Set the calcid to a higher value than Excel itself will use, otherwise Excel will always recalc
171		// If MS Excel does do a recalc, then users opening a file in MS Excel will be prompted to save on exit
172		// because the file has changed
173	60	$objWriter->writeAttribute('calcId', '999999');
174	60	$objWriter->writeAttribute('calcMode', 'auto');
175		// fullCalcOnLoad isn't needed if we've recalculating for the save
176	60	$objWriter->writeAttribute('calcCompleted', ($recalcRequired) ? 1 : 0);
177	60	$objWriter->writeAttribute('fullCalcOnLoad', ($recalcRequired) ? 0 : 1);
178
179	60	$objWriter->endElement();
180	60	}
181
182		/**
183		* Write sheets.
184		*
185		* @param XMLWriter $objWriter XML Writer
186		* @param Spreadsheet $spreadsheet
187		*
188		* @throws WriterException
189		*/
190	60	private function writeSheets(XMLWriter $objWriter, Spreadsheet $spreadsheet)
191		{
192		// Write sheets
193	60	$objWriter->startElement('sheets');
194	60	$sheetCount = $spreadsheet->getSheetCount();
195	60	for ($i = 0; $i < $sheetCount; ++$i) {
196		// sheet
197	60	$this->writeSheet(
198	60	$objWriter,
199	60	$spreadsheet->getSheet($i)->getTitle(),
200	60	($i + 1),
201	60	($i + 1 + 3),
202	60	$spreadsheet->getSheet($i)->getSheetState()
203		);
204		}
205
206	60	$objWriter->endElement();
207	60	}
208
209		/**
210		* Write sheet.
211		*
212		* @param XMLWriter $objWriter XML Writer
213		* @param string $pSheetname Sheet name
214		* @param int $pSheetId Sheet id
215		* @param int $pRelId Relationship ID
216		* @param string $sheetState Sheet state (visible, hidden, veryHidden)
217		*
218		* @throws WriterException
219		*/
220	60	private function writeSheet(XMLWriter $objWriter, $pSheetname, $pSheetId = 1, $pRelId = 1, $sheetState = 'visible')
221		{
222	60	if ($pSheetname != '') {
223		// Write sheet
224	60	$objWriter->startElement('sheet');
225	60	$objWriter->writeAttribute('name', $pSheetname);
226	60	$objWriter->writeAttribute('sheetId', $pSheetId);
227	60	if ($sheetState != 'visible' && $sheetState != '') {
228		$objWriter->writeAttribute('state', $sheetState);
229		}
230	60	$objWriter->writeAttribute('r:id', 'rId' . $pRelId);
231	60	$objWriter->endElement();
232		} else {
233		throw new WriterException('Invalid parameters passed.');
234		}
235	60	}
236
237		/**
238		* Write Defined Names.
239		*
240		* @param XMLWriter $objWriter XML Writer
241		* @param Spreadsheet $spreadsheet
242		*
243		* @throws WriterException
244		*/
245	60	private function writeDefinedNames(XMLWriter $objWriter, Spreadsheet $spreadsheet)
246		{
247		// Write defined names
248	60	$objWriter->startElement('definedNames');
249
250		// Named ranges
251	60	if (count($spreadsheet->getNamedRanges()) > 0) {
252		// Named ranges
253	4	$this->writeNamedRanges($objWriter, $spreadsheet);
254		}
255
256		// Other defined names
257	60	$sheetCount = $spreadsheet->getSheetCount();
258	60	for ($i = 0; $i < $sheetCount; ++$i) {
259		// definedName for autoFilter
260	60	$this->writeDefinedNameForAutofilter($objWriter, $spreadsheet->getSheet($i), $i);
261
262		// definedName for Print_Titles
263	60	$this->writeDefinedNameForPrintTitles($objWriter, $spreadsheet->getSheet($i), $i);
264
265		// definedName for Print_Area
266	60	$this->writeDefinedNameForPrintArea($objWriter, $spreadsheet->getSheet($i), $i);
267		}
268
269	60	$objWriter->endElement();
270	60	}
271
272		/**
273		* Write named ranges.
274		*
275		* @param XMLWriter $objWriter XML Writer
276		* @param Spreadsheet $spreadsheet
277		*
278		* @throws WriterException
279		*/
280	4	private function writeNamedRanges(XMLWriter $objWriter, Spreadsheet $spreadsheet)
281		{
282		// Loop named ranges
283	4	$namedRanges = $spreadsheet->getNamedRanges();
284	4	foreach ($namedRanges as $namedRange) {
285	4	$this->writeDefinedNameForNamedRange($objWriter, $namedRange);
286		}
287	4	}
288
289		/**
290		* Write Defined Name for named range.
291		*
292		* @param XMLWriter $objWriter XML Writer
293		* @param NamedRange $pNamedRange
294		*/
295	4	private function writeDefinedNameForNamedRange(XMLWriter $objWriter, NamedRange $pNamedRange)
296		{
297		// definedName for named range
298	4	$objWriter->startElement('definedName');
299	4	$objWriter->writeAttribute('name', $pNamedRange->getName());
300	4	if ($pNamedRange->getLocalOnly()) {
301		$objWriter->writeAttribute('localSheetId', $pNamedRange->getScope()->getParent()->getIndex($pNamedRange->getScope()));
302		}
303
304		// Create absolute coordinate and write as raw text
305	4	$range = Coordinate::splitRange($pNamedRange->getRange());
306	4	$iMax = count($range);
307	4	for ($i = 0; $i < $iMax; ++$i) {
308	4	$range[$i][0] = '\'' . str_replace("'", "''", $pNamedRange->getWorksheet()->getTitle()) . '\'!' . Coordinate::absoluteReference($range[$i][0]);
309	4	if (isset($range[$i][1])) {
310	3	$range[$i][1] = Coordinate::absoluteReference($range[$i][1]);
311		}
312		}
313	4	$range = Coordinate::buildRange($range);
314
315	4	$objWriter->writeRawData($range);
316
317	4	$objWriter->endElement();
318	4	}
319
320		/**
321		* Write Defined Name for autoFilter.
322		*
323		* @param XMLWriter $objWriter XML Writer
324		* @param Worksheet $pSheet
325		* @param int $pSheetId
326		*/
327	60	private function writeDefinedNameForAutofilter(XMLWriter $objWriter, Worksheet $pSheet, $pSheetId = 0)
328		{
329		// definedName for autoFilter
330	60	$autoFilterRange = $pSheet->getAutoFilter()->getRange();
331	60	if (!empty($autoFilterRange)) {
332	3	$objWriter->startElement('definedName');
333	3	$objWriter->writeAttribute('name', '_xlnm._FilterDatabase');
334	3	$objWriter->writeAttribute('localSheetId', $pSheetId);
335	3	$objWriter->writeAttribute('hidden', '1');
336
337		// Create absolute coordinate and write as raw text
338	3	$range = Coordinate::splitRange($autoFilterRange);
339	3	$range = $range[0];
340		// Strip any worksheet ref so we can make the cell ref absolute
341	3	if (strpos($range[0], '!') !== false) {
342		list($ws, $range[0]) = explode('!', $range[0]);
343		}
344
345	3	$range[0] = Coordinate::absoluteCoordinate($range[0]);
346	3	$range[1] = Coordinate::absoluteCoordinate($range[1]);
347	3	$range = implode(':', $range);
348
349	3	$objWriter->writeRawData('\'' . str_replace("'", "''", $pSheet->getTitle()) . '\'!' . $range);
350
351	3	$objWriter->endElement();
352		}
353	60	}
354
355		/**
356		* Write Defined Name for PrintTitles.
357		*
358		* @param XMLWriter $objWriter XML Writer
359		* @param Worksheet $pSheet
360		* @param int $pSheetId
361		*/
362	60	private function writeDefinedNameForPrintTitles(XMLWriter $objWriter, Worksheet $pSheet, $pSheetId = 0)
363		{
364		// definedName for PrintTitles
365	60	if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet() \|\| $pSheet->getPageSetup()->isRowsToRepeatAtTopSet()) {
366	1	$objWriter->startElement('definedName');
367	1	$objWriter->writeAttribute('name', '_xlnm.Print_Titles');
368	1	$objWriter->writeAttribute('localSheetId', $pSheetId);
369
370		// Setting string
371	1	$settingString = '';
372
373		// Columns to repeat
374	1	if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet()) {
375		$repeat = $pSheet->getPageSetup()->getColumnsToRepeatAtLeft();
376
377		$settingString .= '\'' . str_replace("'", "''", $pSheet->getTitle()) . '\'!$' . $repeat[0] . ':$' . $repeat[1];
378		}
379
380		// Rows to repeat
381	1	if ($pSheet->getPageSetup()->isRowsToRepeatAtTopSet()) {
382	1	if ($pSheet->getPageSetup()->isColumnsToRepeatAtLeftSet()) {
383		$settingString .= ',';
384		}
385
386	1	$repeat = $pSheet->getPageSetup()->getRowsToRepeatAtTop();
387
388	1	$settingString .= '\'' . str_replace("'", "''", $pSheet->getTitle()) . '\'!$' . $repeat[0] . ':$' . $repeat[1];
389		}
390
391	1	$objWriter->writeRawData($settingString);
392
393	1	$objWriter->endElement();
394		}
395	60	}
396
397		/**
398		* Write Defined Name for PrintTitles.
399		*
400		* @param XMLWriter $objWriter XML Writer
401		* @param Worksheet $pSheet
402		* @param int $pSheetId
403		*/
404	60	private function writeDefinedNameForPrintArea(XMLWriter $objWriter, Worksheet $pSheet, $pSheetId = 0)
405		{
406		// definedName for PrintArea
407	60	if ($pSheet->getPageSetup()->isPrintAreaSet()) {
408		$objWriter->startElement('definedName');
409		$objWriter->writeAttribute('name', '_xlnm.Print_Area');
410		$objWriter->writeAttribute('localSheetId', $pSheetId);
411
412		// Print area
413		$printArea = Coordinate::splitRange($pSheet->getPageSetup()->getPrintArea());
414
415		$chunks = [];
416		foreach ($printArea as $printAreaRect) {
417		$printAreaRect[0] = Coordinate::absoluteReference($printAreaRect[0]);
418		$printAreaRect[1] = Coordinate::absoluteReference($printAreaRect[1]);
419		$chunks[] = '\'' . str_replace("'", "''", $pSheet->getTitle()) . '\'!' . implode(':', $printAreaRect);
420		}
421
422		$objWriter->writeRawData(implode(',', $chunks));
423
424		$objWriter->endElement();
425		}
426	60	}
427		}
428

PHPOffice / PhpSpreadsheet

Push — develop ( c96e2d...d2f55f )

Workbook::writeWorkbookPr() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like