Workbook::writeWorkbookPr() - Code Metrics - Inspection of "Merge pull request #4271 from oleibman/issue4269" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 08e226...af07ad )

unknown

created 2024-12-23 01:55 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
eloc	5
c	0
b	0
f	0
dl	0
loc	11
rs	10
ccs	5
cts	6
cp	0.8333
cc	2
nc	2
nop	2
crap	2.0185

<?php

namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;

use PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces;
use PhpOffice\PhpSpreadsheet\Shared\Date;
use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException;
use PhpOffice\PhpSpreadsheet\Writer\Xlsx\DefinedNames as DefinedNamesWriter;

class Workbook extends WriterPart
{
    /**
     * Write workbook to XML format.
     *
     * @param bool $preCalculateFormulas If true, formulas will be calculated before writing
     * @param ?bool $forceFullCalc If null, !$preCalculateFormulas
     *
     * @return string XML Output
     */
    public function writeWorkbook(Spreadsheet $spreadsheet, bool $preCalculateFormulas = false, ?bool $forceFullCalc = null): string
    {
        // 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', Namespaces::MAIN);
        $objWriter->writeAttribute('xmlns:r', Namespaces::SCHEMA_OFFICE_DOCUMENT);

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

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

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

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

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

        // definedNames
        (new DefinedNamesWriter($objWriter, $spreadsheet))->write();

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

        $objWriter->endElement();

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

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

    /**
     * Write WorkbookPr.
     */
    private function writeWorkbookPr(XMLWriter $objWriter, Spreadsheet $spreadsheet): void
    {
        $objWriter->startElement('workbookPr');

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

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

        $objWriter->endElement();
    }

    /**
     * Write BookViews.
     */
    private function writeBookViews(XMLWriter $objWriter, Spreadsheet $spreadsheet): void
    {
        // bookViews
        $objWriter->startElement('bookViews');

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

        $objWriter->writeAttribute('activeTab', (string) $spreadsheet->getActiveSheetIndex());
        $objWriter->writeAttribute('autoFilterDateGrouping', ($spreadsheet->getAutoFilterDateGrouping() ? 'true' : 'false'));
        $objWriter->writeAttribute('firstSheet', (string) $spreadsheet->getFirstSheetIndex());
        $objWriter->writeAttribute('minimized', ($spreadsheet->getMinimized() ? 'true' : 'false'));
        $objWriter->writeAttribute('showHorizontalScroll', ($spreadsheet->getShowHorizontalScroll() ? 'true' : 'false'));
        $objWriter->writeAttribute('showSheetTabs', ($spreadsheet->getShowSheetTabs() ? 'true' : 'false'));
        $objWriter->writeAttribute('showVerticalScroll', ($spreadsheet->getShowVerticalScroll() ? 'true' : 'false'));
        $objWriter->writeAttribute('tabRatio', (string) $spreadsheet->getTabRatio());
        $objWriter->writeAttribute('visibility', $spreadsheet->getVisibility());

        $objWriter->endElement();

        $objWriter->endElement();
    }

    /**
     * Write WorkbookProtection.
     */
    private function writeWorkbookProtection(XMLWriter $objWriter, Spreadsheet $spreadsheet): void
    {
        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 bool $preCalculateFormulas If true, formulas will be calculated before writing
     */
    private function writeCalcPr(XMLWriter $objWriter, bool $preCalculateFormulas, ?bool $forceFullCalc): void
    {
        $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 will calculate before writing
        $objWriter->writeAttribute('calcCompleted', ($preCalculateFormulas) ? '1' : '0');
        $objWriter->writeAttribute('fullCalcOnLoad', ($preCalculateFormulas) ? '0' : '1');
        if ($forceFullCalc === null) {
            $objWriter->writeAttribute('forceFullCalc', $preCalculateFormulas ? '0' : '1');
        } else {
            $objWriter->writeAttribute('forceFullCalc', $forceFullCalc ? '1' : '0');
        }

        $objWriter->endElement();
    }

    /**
     * Write sheets.
     */
    private function writeSheets(XMLWriter $objWriter, Spreadsheet $spreadsheet): void
    {
        // 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 string $worksheetName Sheet name
     * @param int $worksheetId Sheet id
     * @param int $relId Relationship ID
     * @param string $sheetState Sheet state (visible, hidden, veryHidden)
     */
    private function writeSheet(XMLWriter $objWriter, string $worksheetName, int $worksheetId = 1, int $relId = 1, string $sheetState = 'visible'): void
    {
        if ($worksheetName != '') {
            // Write sheet
            $objWriter->startElement('sheet');
            $objWriter->writeAttribute('name', $worksheetName);
            $objWriter->writeAttribute('sheetId', (string) $worksheetId);
            if ($sheetState !== 'visible' && $sheetState != '') {
                $objWriter->writeAttribute('state', $sheetState);
            }
            $objWriter->writeAttribute('r:id', 'rId' . $relId);
            $objWriter->endElement();
        } else {
            throw new WriterException('Invalid parameters passed.');
        }
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx;
4
5		use PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces;
6		use PhpOffice\PhpSpreadsheet\Shared\Date;
7		use PhpOffice\PhpSpreadsheet\Shared\XMLWriter;
8		use PhpOffice\PhpSpreadsheet\Spreadsheet;
9		use PhpOffice\PhpSpreadsheet\Writer\Exception as WriterException;
10		use PhpOffice\PhpSpreadsheet\Writer\Xlsx\DefinedNames as DefinedNamesWriter;
11
12		class Workbook extends WriterPart
13		{
14		/**
15		* Write workbook to XML format.
16		*
17		* @param bool $preCalculateFormulas If true, formulas will be calculated before writing
18		* @param ?bool $forceFullCalc If null, !$preCalculateFormulas
19		*
20		* @return string XML Output
21		*/
22	364	public function writeWorkbook(Spreadsheet $spreadsheet, bool $preCalculateFormulas = false, ?bool $forceFullCalc = null): string
23		{
24		// Create XML writer
25	364	if ($this->getParentWriter()->getUseDiskCaching()) {
26		$objWriter = new XMLWriter(XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
27		} else {
28	364	$objWriter = new XMLWriter(XMLWriter::STORAGE_MEMORY);
29		}
30
31		// XML header
32	364	$objWriter->startDocument('1.0', 'UTF-8', 'yes');
33
34		// workbook
35	364	$objWriter->startElement('workbook');
36	364	$objWriter->writeAttribute('xml:space', 'preserve');
37	364	$objWriter->writeAttribute('xmlns', Namespaces::MAIN);
38	364	$objWriter->writeAttribute('xmlns:r', Namespaces::SCHEMA_OFFICE_DOCUMENT);
39
40		// fileVersion
41	364	$this->writeFileVersion($objWriter);
42
43		// workbookPr
44	364	$this->writeWorkbookPr($objWriter, $spreadsheet);
45
46		// workbookProtection
47	364	$this->writeWorkbookProtection($objWriter, $spreadsheet);
48
49		// bookViews
50	364	if ($this->getParentWriter()->getOffice2003Compatibility() === false) {
51	364	$this->writeBookViews($objWriter, $spreadsheet);
52		}
53
54		// sheets
55	364	$this->writeSheets($objWriter, $spreadsheet);
56
57		// definedNames
58	364	(new DefinedNamesWriter($objWriter, $spreadsheet))->write();
59
60		// calcPr
61	364	$this->writeCalcPr($objWriter, $preCalculateFormulas, $forceFullCalc);
62
63	364	$objWriter->endElement();
64
65		// Return
66	364	return $objWriter->getData();
67		}
68
69		/**
70		* Write file version.
71		*/
72	364	private function writeFileVersion(XMLWriter $objWriter): void
73		{
74	364	$objWriter->startElement('fileVersion');
75	364	$objWriter->writeAttribute('appName', 'xl');
76	364	$objWriter->writeAttribute('lastEdited', '4');
77	364	$objWriter->writeAttribute('lowestEdited', '4');
78	364	$objWriter->writeAttribute('rupBuild', '4505');
79	364	$objWriter->endElement();
80		}
81
82		/**
83		* Write WorkbookPr.
84		*/
85	364	private function writeWorkbookPr(XMLWriter $objWriter, Spreadsheet $spreadsheet): void
86		{
87	364	$objWriter->startElement('workbookPr');
88
89	364	if ($spreadsheet->getExcelCalendar() === Date::CALENDAR_MAC_1904) {
90		$objWriter->writeAttribute('date1904', '1');
91		}
92
93	364	$objWriter->writeAttribute('codeName', 'ThisWorkbook');
94
95	364	$objWriter->endElement();
96		}
97
98		/**
99		* Write BookViews.
100		*/
101	364	private function writeBookViews(XMLWriter $objWriter, Spreadsheet $spreadsheet): void
102		{
103		// bookViews
104	364	$objWriter->startElement('bookViews');
105
106		// workbookView
107	364	$objWriter->startElement('workbookView');
108
109	364	$objWriter->writeAttribute('activeTab', (string) $spreadsheet->getActiveSheetIndex());
110	364	$objWriter->writeAttribute('autoFilterDateGrouping', ($spreadsheet->getAutoFilterDateGrouping() ? 'true' : 'false'));
111	364	$objWriter->writeAttribute('firstSheet', (string) $spreadsheet->getFirstSheetIndex());
112	364	$objWriter->writeAttribute('minimized', ($spreadsheet->getMinimized() ? 'true' : 'false'));
113	364	$objWriter->writeAttribute('showHorizontalScroll', ($spreadsheet->getShowHorizontalScroll() ? 'true' : 'false'));
114	364	$objWriter->writeAttribute('showSheetTabs', ($spreadsheet->getShowSheetTabs() ? 'true' : 'false'));
115	364	$objWriter->writeAttribute('showVerticalScroll', ($spreadsheet->getShowVerticalScroll() ? 'true' : 'false'));
116	364	$objWriter->writeAttribute('tabRatio', (string) $spreadsheet->getTabRatio());
117	364	$objWriter->writeAttribute('visibility', $spreadsheet->getVisibility());
118
119	364	$objWriter->endElement();
120
121	364	$objWriter->endElement();
122		}
123
124		/**
125		* Write WorkbookProtection.
126		*/
127	364	private function writeWorkbookProtection(XMLWriter $objWriter, Spreadsheet $spreadsheet): void
128		{
129	364	if ($spreadsheet->getSecurity()->isSecurityEnabled()) {
130	11	$objWriter->startElement('workbookProtection');
131	11	$objWriter->writeAttribute('lockRevision', ($spreadsheet->getSecurity()->getLockRevision() ? 'true' : 'false'));
132	11	$objWriter->writeAttribute('lockStructure', ($spreadsheet->getSecurity()->getLockStructure() ? 'true' : 'false'));
133	11	$objWriter->writeAttribute('lockWindows', ($spreadsheet->getSecurity()->getLockWindows() ? 'true' : 'false'));
134
135	11	if ($spreadsheet->getSecurity()->getRevisionsPassword() != '') {
136	1	$objWriter->writeAttribute('revisionsPassword', $spreadsheet->getSecurity()->getRevisionsPassword());
137		}
138
139	11	if ($spreadsheet->getSecurity()->getWorkbookPassword() != '') {
140	4	$objWriter->writeAttribute('workbookPassword', $spreadsheet->getSecurity()->getWorkbookPassword());
141		}
142
143	11	$objWriter->endElement();
144		}
145		}
146
147		/**
148		* Write calcPr.
149		*
150		* @param bool $preCalculateFormulas If true, formulas will be calculated before writing
151		*/
152	364	private function writeCalcPr(XMLWriter $objWriter, bool $preCalculateFormulas, ?bool $forceFullCalc): void
153		{
154	364	$objWriter->startElement('calcPr');
155
156		// Set the calcid to a higher value than Excel itself will use, otherwise Excel will always recalc
157		// If MS Excel does do a recalc, then users opening a file in MS Excel will be prompted to save on exit
158		// because the file has changed
159	364	$objWriter->writeAttribute('calcId', '999999');
160	364	$objWriter->writeAttribute('calcMode', 'auto');
161		// fullCalcOnLoad isn't needed if we will calculate before writing
162	364	$objWriter->writeAttribute('calcCompleted', ($preCalculateFormulas) ? '1' : '0');
163	364	$objWriter->writeAttribute('fullCalcOnLoad', ($preCalculateFormulas) ? '0' : '1');
164	364	if ($forceFullCalc === null) {
165	362	$objWriter->writeAttribute('forceFullCalc', $preCalculateFormulas ? '0' : '1');
166		} else {
167	2	$objWriter->writeAttribute('forceFullCalc', $forceFullCalc ? '1' : '0');
168		}
169
170	364	$objWriter->endElement();
171		}
172
173		/**
174		* Write sheets.
175		*/
176	364	private function writeSheets(XMLWriter $objWriter, Spreadsheet $spreadsheet): void
177		{
178		// Write sheets
179	364	$objWriter->startElement('sheets');
180	364	$sheetCount = $spreadsheet->getSheetCount();
181	364	for ($i = 0; $i < $sheetCount; ++$i) {
182		// sheet
183	364	$this->writeSheet(
184	364	$objWriter,
185	364	$spreadsheet->getSheet($i)->getTitle(),
186	364	($i + 1),
187	364	($i + 1 + 3),
188	364	$spreadsheet->getSheet($i)->getSheetState()
189	364	);
190		}
191
192	364	$objWriter->endElement();
193		}
194
195		/**
196		* Write sheet.
197		*
198		* @param string $worksheetName Sheet name
199		* @param int $worksheetId Sheet id
200		* @param int $relId Relationship ID
201		* @param string $sheetState Sheet state (visible, hidden, veryHidden)
202		*/
203	364	private function writeSheet(XMLWriter $objWriter, string $worksheetName, int $worksheetId = 1, int $relId = 1, string $sheetState = 'visible'): void
204		{
205	364	if ($worksheetName != '') {
206		// Write sheet
207	364	$objWriter->startElement('sheet');
208	364	$objWriter->writeAttribute('name', $worksheetName);
209	364	$objWriter->writeAttribute('sheetId', (string) $worksheetId);
210	364	if ($sheetState !== 'visible' && $sheetState != '') {
211	4	$objWriter->writeAttribute('state', $sheetState);
212		}
213	364	$objWriter->writeAttribute('r:id', 'rId' . $relId);
214	364	$objWriter->endElement();
215		} else {
216		throw new WriterException('Invalid parameters passed.');
217		}
218		}
219		}
220

PHPOffice / PhpSpreadsheet

Push — master ( 08e226...af07ad )

Workbook::writeWorkbookPr() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like