Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\Xls:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Writer\Xls:

Public Member Functions
	__construct (Spreadsheet $spreadsheet)
	Create a new Xls Writer. More...

	save ($pFilename)
	Save Spreadsheet to file. More...

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	getIncludeCharts ()
	Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object. More...

	setIncludeCharts ($pValue)
	Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object. More...

	getPreCalculateFormulas ()
	Get Pre-Calculate Formulas flag If this is true (the default), then the writer will recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file If false, then formulae are not calculated on save. More...

	setPreCalculateFormulas ($pValue)
	Set Pre-Calculate Formulas Set to true (the default) to advise the Writer to calculate all formulae on save Set to false to prevent precalculation of formulae on save. More...

	getUseDiskCaching ()
	Get use disk caching where possible? More...

	setUseDiskCaching ($pValue, $pDirectory=null)
	Set use disk caching where possible? More...

	getDiskCachingDirectory ()
	Get disk caching directory. More...

	openFileHandle ($filename)
	Open file handle. More...

	__construct (Spreadsheet $spreadsheet)
	IWriter constructor. More...

	getIncludeCharts ()
	Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object. More...

	setIncludeCharts ($pValue)
	Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object. More...

	getPreCalculateFormulas ()
	Get Pre-Calculate Formulas flag If this is true (the default), then the writer will recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file If false, then formulae are not calculated on save. More...

	setPreCalculateFormulas ($pValue)
	Set Pre-Calculate Formulas Set to true (the default) to advise the Writer to calculate all formulae on save Set to false to prevent precalculation of formulae on save. More...

	save ($pFilename)
	Save PhpSpreadsheet to file. More...

	getUseDiskCaching ()
	Get use disk caching where possible? More...

	setUseDiskCaching ($pValue, $pDirectory=null)
	Set use disk caching where possible? More...

	getDiskCachingDirectory ()
	Get disk caching directory. More...

Private Member Functions
	buildWorksheetEschers ()
	Build the Worksheet Escher objects. More...

	processMemoryDrawing (BstoreContainer &$bstoreContainer, MemoryDrawing $drawing, string $renderingFunctionx)

	processDrawing (BstoreContainer &$bstoreContainer, Drawing $drawing)

	processBaseDrawing (BstoreContainer &$bstoreContainer, BaseDrawing $drawing)

	checkForDrawings ()

	buildWorkbookEscher ()
	Build the Escher object corresponding to the MSODRAWINGGROUP record. More...

	writeDocumentSummaryInformation ()
	Build the OLE Part for DocumentSummary Information. More...

	writeSummaryPropOle ($dataProp, int &$dataSection_NumProps, array &$dataSection, int $sumdata, int $typdata)

	writeSummaryProp (string $dataProp, int &$dataSection_NumProps, array &$dataSection, int $sumdata, int $typdata)

	writeSummaryInformation ()
	Build the OLE Part for Summary Information. More...

Private Attributes
	$spreadsheet

	$strTotal = 0

	$strUnique = 0

	$strTable = []

	$colors

	$parser

	$IDCLs

	$summaryInformation

	$documentSummaryInformation

	$writerWorkbook

	$writerWorksheets

Additional Inherited Members
Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	maybeCloseFileHandle ()
	Close file handle only if we opened it ourselves. More...

Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter
	$includeCharts = false

	$preCalculateFormulas = true

	$fileHandle

Detailed Description

Definition at line 30 of file Xls.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Writer\Xls::__construct ( Spreadsheet $spreadsheet )

Create a new Xls Writer.

Parameters

Spreadsheet $spreadsheet PhpSpreadsheet object

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 110 of file Xls.php.

    {
        $this->spreadsheet = $spreadsheet;
 
        $this->parser = new Xls\Parser($spreadsheet);
    }

References PhpOffice\PhpSpreadsheet\Writer\Xls\$spreadsheet.

Member Function Documentation

◆ buildWorkbookEscher()

PhpOffice\PhpSpreadsheet\Writer\Xls::buildWorkbookEscher ( )

private

Build the Escher object corresponding to the MSODRAWINGGROUP record.

Definition at line 500 of file Xls.php.

                                          : void
    {
        // nothing to do if there are no drawings
        if (!$this->checkForDrawings()) {
            return;
        }
 
        // if we reach here, then there are drawings in the workbook
        $escher = new Escher();
 
        // dggContainer
        $dggContainer = new DggContainer();
        $escher->setDggContainer($dggContainer);
 
        // set IDCLs (identifier clusters)
        $dggContainer->setIDCLs($this->IDCLs);
 
        // this loop is for determining maximum shape identifier of all drawing
        $spIdMax = 0;
        $totalCountShapes = 0;
        $countDrawings = 0;
 
        foreach ($this->spreadsheet->getAllsheets() as $sheet) {
            $sheetCountShapes = 0; // count number of shapes (minus group shape), in sheet
 
            $addCount = 0;
            foreach ($sheet->getDrawingCollection() as $drawing) {
                $addCount = 1;
                ++$sheetCountShapes;
                ++$totalCountShapes;
 
                $spId = $sheetCountShapes | ($this->spreadsheet->getIndex($sheet) + 1) << 10;
                $spIdMax = max($spId, $spIdMax);
            }
            $countDrawings += $addCount;
        }
 
        $dggContainer->setSpIdMax($spIdMax + 1);
        $dggContainer->setCDgSaved($countDrawings);
        $dggContainer->setCSpSaved($totalCountShapes + $countDrawings); // total number of shapes incl. one group shapes per drawing
 
        // bstoreContainer
        $bstoreContainer = new BstoreContainer();
        $dggContainer->setBstoreContainer($bstoreContainer);
 
        // the BSE's (all the images)
        foreach ($this->spreadsheet->getAllsheets() as $sheet) {
            foreach ($sheet->getDrawingCollection() as $drawing) {
                $this->processBaseDrawing($bstoreContainer, $drawing);
            }
        }
 
        // Set the Escher object
        $this->writerWorkbook->setEscher($escher);
    }

References PhpOffice\PhpSpreadsheet\Writer\Xls\checkForDrawings(), and PhpOffice\PhpSpreadsheet\Writer\Xls\processBaseDrawing().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildWorksheetEschers()

PhpOffice\PhpSpreadsheet\Writer\Xls::buildWorksheetEschers ( )

private

Build the Worksheet Escher objects.

Definition at line 236 of file Xls.php.

                                            : void
    {
        // 1-based index to BstoreContainer
        $blipIndex = 0;
        $lastReducedSpId = 0;
        $lastSpId = 0;
 
        foreach ($this->spreadsheet->getAllsheets() as $sheet) {
            // sheet index
            $sheetIndex = $sheet->getParent()->getIndex($sheet);
 
            $escher = null;
 
            // check if there are any shapes for this sheet
            $filterRange = $sheet->getAutoFilter()->getRange();
            if (count($sheet->getDrawingCollection()) == 0 && empty($filterRange)) {
                continue;
            }
 
            // create intermediate Escher object
            $escher = new Escher();
 
            // dgContainer
            $dgContainer = new DgContainer();
 
            // set the drawing index (we use sheet index + 1)
            $dgId = $sheet->getParent()->getIndex($sheet) + 1;
            $dgContainer->setDgId($dgId);
            $escher->setDgContainer($dgContainer);
 
            // spgrContainer
            $spgrContainer = new SpgrContainer();
            $dgContainer->setSpgrContainer($spgrContainer);
 
            // add one shape which is the group shape
            $spContainer = new SpContainer();
            $spContainer->setSpgr(true);
            $spContainer->setSpType(0);
            $spContainer->setSpId(($sheet->getParent()->getIndex($sheet) + 1) << 10);
            $spgrContainer->addChild($spContainer);
 
            // add the shapes
 
            $countShapes[$sheetIndex] = 0; // count number of shapes (minus group shape), in sheet
 
            foreach ($sheet->getDrawingCollection() as $drawing) {
                ++$blipIndex;
 
                ++$countShapes[$sheetIndex];
 
                // add the shape
                $spContainer = new SpContainer();
 
                // set the shape type
                $spContainer->setSpType(0x004B);
                // set the shape flag
                $spContainer->setSpFlag(0x02);
 
                // set the shape index (we combine 1-based sheet index and $countShapes to create unique shape index)
                $reducedSpId = $countShapes[$sheetIndex];
                $spId = $reducedSpId | ($sheet->getParent()->getIndex($sheet) + 1) << 10;
                $spContainer->setSpId($spId);
 
                // keep track of last reducedSpId
                $lastReducedSpId = $reducedSpId;
 
                // keep track of last spId
                $lastSpId = $spId;
 
                // set the BLIP index
                $spContainer->setOPT(0x4104, $blipIndex);
 
                // set coordinates and offsets, client anchor
                $coordinates = $drawing->getCoordinates();
                $offsetX = $drawing->getOffsetX();
                $offsetY = $drawing->getOffsetY();
                $width = $drawing->getWidth();
                $height = $drawing->getHeight();
 
                $twoAnchor = \PhpOffice\PhpSpreadsheet\Shared\Xls::oneAnchor2twoAnchor($sheet, $coordinates, $offsetX, $offsetY, $width, $height);
 
                $spContainer->setStartCoordinates($twoAnchor['startCoordinates']);
                $spContainer->setStartOffsetX($twoAnchor['startOffsetX']);
                $spContainer->setStartOffsetY($twoAnchor['startOffsetY']);
                $spContainer->setEndCoordinates($twoAnchor['endCoordinates']);
                $spContainer->setEndOffsetX($twoAnchor['endOffsetX']);
                $spContainer->setEndOffsetY($twoAnchor['endOffsetY']);
 
                $spgrContainer->addChild($spContainer);
            }
 
            // AutoFilters
            if (!empty($filterRange)) {
                $rangeBounds = Coordinate::rangeBoundaries($filterRange);
                $iNumColStart = $rangeBounds[0][0];
                $iNumColEnd = $rangeBounds[1][0];
 
                $iInc = $iNumColStart;
                while ($iInc <= $iNumColEnd) {
                    ++$countShapes[$sheetIndex];
 
                    // create an Drawing Object for the dropdown
                    $oDrawing = new BaseDrawing();
                    // get the coordinates of drawing
                    $cDrawing = Coordinate::stringFromColumnIndex($iInc) . $rangeBounds[0][1];
                    $oDrawing->setCoordinates($cDrawing);
                    $oDrawing->setWorksheet($sheet);
 
                    // add the shape
                    $spContainer = new SpContainer();
                    // set the shape type
                    $spContainer->setSpType(0x00C9);
                    // set the shape flag
                    $spContainer->setSpFlag(0x01);
 
                    // set the shape index (we combine 1-based sheet index and $countShapes to create unique shape index)
                    $reducedSpId = $countShapes[$sheetIndex];
                    $spId = $reducedSpId | ($sheet->getParent()->getIndex($sheet) + 1) << 10;
                    $spContainer->setSpId($spId);
 
                    // keep track of last reducedSpId
                    $lastReducedSpId = $reducedSpId;
 
                    // keep track of last spId
                    $lastSpId = $spId;
 
                    $spContainer->setOPT(0x007F, 0x01040104); // Protection -> fLockAgainstGrouping
                    $spContainer->setOPT(0x00BF, 0x00080008); // Text -> fFitTextToShape
                    $spContainer->setOPT(0x01BF, 0x00010000); // Fill Style -> fNoFillHitTest
                    $spContainer->setOPT(0x01FF, 0x00080000); // Line Style -> fNoLineDrawDash
                    $spContainer->setOPT(0x03BF, 0x000A0000); // Group Shape -> fPrint
 
                    // set coordinates and offsets, client anchor
                    $endCoordinates = Coordinate::stringFromColumnIndex($iInc);
                    $endCoordinates .= $rangeBounds[0][1] + 1;
 
                    $spContainer->setStartCoordinates($cDrawing);
                    $spContainer->setStartOffsetX(0);
                    $spContainer->setStartOffsetY(0);
                    $spContainer->setEndCoordinates($endCoordinates);
                    $spContainer->setEndOffsetX(0);
                    $spContainer->setEndOffsetY(0);
 
                    $spgrContainer->addChild($spContainer);
                    ++$iInc;
                }
            }
 
            // identifier clusters, used for workbook Escher object
            $this->IDCLs[$dgId] = $lastReducedSpId;
 
            // set last shape index
            $dgContainer->setLastSpId($lastSpId);
 
            // set the Escher object
            $this->writerWorksheets[$sheetIndex]->setEscher($escher);
        }
    }

References PhpOffice\PhpSpreadsheet\Shared\Xls\oneAnchor2twoAnchor(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\rangeBoundaries(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkForDrawings()

PhpOffice\PhpSpreadsheet\Writer\Xls::checkForDrawings ( )

private

Definition at line 482 of file Xls.php.

                                       : bool
    {
        // any drawings in this workbook?
        $found = false;
        foreach ($this->spreadsheet->getAllSheets() as $sheet) {
            if (count($sheet->getDrawingCollection()) > 0) {
                $found = true;
 
                break;
            }
        }
 
        return $found;
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\buildWorkbookEscher().

Here is the caller graph for this function:

◆ processBaseDrawing()

PhpOffice\PhpSpreadsheet\Writer\Xls::processBaseDrawing	(	BstoreContainer &	$bstoreContainer,
		BaseDrawing	$drawing
	)

private

Definition at line 473 of file Xls.php.

                                                                                                : void
    {
        if ($drawing instanceof Drawing) {
            $this->processDrawing($bstoreContainer, $drawing);
        } elseif ($drawing instanceof MemoryDrawing) {
            $this->processMemoryDrawing($bstoreContainer, $drawing, $drawing->getRenderingFunction());
        }
    }

References PhpOffice\PhpSpreadsheet\Writer\Xls\processDrawing(), and PhpOffice\PhpSpreadsheet\Writer\Xls\processMemoryDrawing().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\buildWorkbookEscher().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processDrawing()

PhpOffice\PhpSpreadsheet\Writer\Xls::processDrawing	(	BstoreContainer &	$bstoreContainer,
		Drawing	$drawing
	)

private

Definition at line 425 of file Xls.php.

                                                                                        : void
    {
        $blipType = null;
        $blipData = '';
        $filename = $drawing->getPath();
 
        [$imagesx, $imagesy, $imageFormat] = getimagesize($filename);
 
        switch ($imageFormat) {
            case 1: // GIF, not supported by BIFF8, we convert to PNG
                $blipType = BSE::BLIPTYPE_PNG;
                ob_start();
                imagepng(imagecreatefromgif($filename));
                $blipData = ob_get_contents();
                ob_end_clean();
 
                break;
            case 2: // JPEG
                $blipType = BSE::BLIPTYPE_JPEG;
                $blipData = file_get_contents($filename);
 
                break;
            case 3: // PNG
                $blipType = BSE::BLIPTYPE_PNG;
                $blipData = file_get_contents($filename);
 
                break;
            case 6: // Windows DIB (BMP), we convert to PNG
                $blipType = BSE::BLIPTYPE_PNG;
                ob_start();
                imagepng(SharedDrawing::imagecreatefrombmp($filename));
                $blipData = ob_get_contents();
                ob_end_clean();
 
                break;
        }
        if ($blipData) {
            $blip = new Blip();
            $blip->setData($blipData);
 
            $BSE = new BSE();
            $BSE->setBlipType($blipType);
            $BSE->setBlip($blip);
 
            $bstoreContainer->addBSE($BSE);
        }
    }

References $filename, PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\addBSE(), PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE\BLIPTYPE_JPEG, PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE\BLIPTYPE_PNG, and PhpOffice\PhpSpreadsheet\Worksheet\Drawing\getPath().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\processBaseDrawing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processMemoryDrawing()

PhpOffice\PhpSpreadsheet\Writer\Xls::processMemoryDrawing	(	BstoreContainer &	$bstoreContainer,
		MemoryDrawing	$drawing,
		string	$renderingFunctionx
	)

private

Definition at line 395 of file Xls.php.

                                                                                                                                : void
    {
        switch ($renderingFunctionx) {
            case MemoryDrawing::RENDERING_JPEG:
                $blipType = BSE::BLIPTYPE_JPEG;
                $renderingFunction = 'imagejpeg';
 
                break;
            default:
                $blipType = BSE::BLIPTYPE_PNG;
                $renderingFunction = 'imagepng';
 
                break;
        }
 
        ob_start();
        call_user_func($renderingFunction, $drawing->getImageResource());
        $blipData = ob_get_contents();
        ob_end_clean();
 
        $blip = new Blip();
        $blip->setData($blipData);
 
        $BSE = new BSE();
        $BSE->setBlipType($blipType);
        $BSE->setBlip($blip);
 
        $bstoreContainer->addBSE($BSE);
    }

References PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\addBSE(), PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE\BLIPTYPE_JPEG, PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BSE\BLIPTYPE_PNG, PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing\getImageResource(), and PhpOffice\PhpSpreadsheet\Worksheet\MemoryDrawing\RENDERING_JPEG.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\processBaseDrawing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

PhpOffice\PhpSpreadsheet\Writer\Xls::save ( $pFilename )

Save Spreadsheet to file.

Parameters

resource | string $pFilename

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 122 of file Xls.php.

                                    : void
    {
        // garbage collect
        $this->spreadsheet->garbageCollect();
 
        $saveDebugLog = Calculation::getInstance($this->spreadsheet)->getDebugLog()->getWriteDebugLog();
        Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog(false);
        $saveDateReturnType = Functions::getReturnDateType();
        Functions::setReturnDateType(Functions::RETURNDATE_EXCEL);
 
        // initialize colors array
        $this->colors = [];
 
        // Initialise workbook writer
        $this->writerWorkbook = new Xls\Workbook($this->spreadsheet, $this->strTotal, $this->strUnique, $this->strTable, $this->colors, $this->parser);
 
        // Initialise worksheet writers
        $countSheets = $this->spreadsheet->getSheetCount();
        for ($i = 0; $i < $countSheets; ++$i) {
            $this->writerWorksheets[$i] = new Xls\Worksheet($this->strTotal, $this->strUnique, $this->strTable, $this->colors, $this->parser, $this->preCalculateFormulas, $this->spreadsheet->getSheet($i));
        }
 
        // build Escher objects. Escher objects for workbooks needs to be build before Escher object for workbook.
        $this->buildWorksheetEschers();
        $this->buildWorkbookEscher();
 
        // add 15 identical cell style Xfs
        // for now, we use the first cellXf instead of cellStyleXf
        $cellXfCollection = $this->spreadsheet->getCellXfCollection();
        for ($i = 0; $i < 15; ++$i) {
            $this->writerWorkbook->addXfWriter($cellXfCollection[0], true);
        }
 
        // add all the cell Xfs
        foreach ($this->spreadsheet->getCellXfCollection() as $style) {
            $this->writerWorkbook->addXfWriter($style, false);
        }
 
        // add fonts from rich text eleemnts
        for ($i = 0; $i < $countSheets; ++$i) {
            foreach ($this->writerWorksheets[$i]->phpSheet->getCoordinates() as $coordinate) {
                $cell = $this->writerWorksheets[$i]->phpSheet->getCell($coordinate);
                $cVal = $cell->getValue();
                if ($cVal instanceof RichText) {
                    $elements = $cVal->getRichTextElements();
                    foreach ($elements as $element) {
                        if ($element instanceof Run) {
                            $font = $element->getFont();
                            $this->writerWorksheets[$i]->fontHashIndex[$font->getHashCode()] = $this->writerWorkbook->addFont($font);
                        }
                    }
                }
            }
        }
 
        // initialize OLE file
        $workbookStreamName = 'Workbook';
        $OLE = new File(OLE::ascToUcs($workbookStreamName));
 
        // Write the worksheet streams before the global workbook stream,
        // because the byte sizes of these are needed in the global workbook stream
        $worksheetSizes = [];
        for ($i = 0; $i < $countSheets; ++$i) {
            $this->writerWorksheets[$i]->close();
            $worksheetSizes[] = $this->writerWorksheets[$i]->_datasize;
        }
 
        // add binary data for global workbook stream
        $OLE->append($this->writerWorkbook->writeWorkbook($worksheetSizes));
 
        // add binary data for sheet streams
        for ($i = 0; $i < $countSheets; ++$i) {
            $OLE->append($this->writerWorksheets[$i]->getData());
        }
 
        $this->documentSummaryInformation = $this->writeDocumentSummaryInformation();
        // initialize OLE Document Summary Information
        if (isset($this->documentSummaryInformation) && !empty($this->documentSummaryInformation)) {
            $OLE_DocumentSummaryInformation = new File(OLE::ascToUcs(chr(5) . 'DocumentSummaryInformation'));
            $OLE_DocumentSummaryInformation->append($this->documentSummaryInformation);
        }
 
        $this->summaryInformation = $this->writeSummaryInformation();
        // initialize OLE Summary Information
        if (isset($this->summaryInformation) && !empty($this->summaryInformation)) {
            $OLE_SummaryInformation = new File(OLE::ascToUcs(chr(5) . 'SummaryInformation'));
            $OLE_SummaryInformation->append($this->summaryInformation);
        }
 
        // define OLE Parts
        $arrRootData = [$OLE];
        // initialize OLE Properties file
        if (isset($OLE_SummaryInformation)) {
            $arrRootData[] = $OLE_SummaryInformation;
        }
        // initialize OLE Extended Properties file
        if (isset($OLE_DocumentSummaryInformation)) {
            $arrRootData[] = $OLE_DocumentSummaryInformation;
        }
 
        $time = $this->spreadsheet->getProperties()->getModified();
        $root = new Root($time, $time, $arrRootData);
        // save the OLE file
        $this->openFileHandle($pFilename);
        $root->save($this->fileHandle);
        $this->maybeCloseFileHandle();
 
        Functions::setReturnDateType($saveDateReturnType);
        Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog($saveDebugLog);
    }

Here is the call graph for this function:

◆ writeDocumentSummaryInformation()

PhpOffice\PhpSpreadsheet\Writer\Xls::writeDocumentSummaryInformation ( )

private

Build the OLE Part for DocumentSummary Information.

Returns: string

Definition at line 561 of file Xls.php.

    {
        // offset: 0; size: 2; must be 0xFE 0xFF (UTF-16 LE byte order mark)
        $data = pack('v', 0xFFFE);
        // offset: 2; size: 2;
        $data .= pack('v', 0x0000);
        // offset: 4; size: 2; OS version
        $data .= pack('v', 0x0106);
        // offset: 6; size: 2; OS indicator
        $data .= pack('v', 0x0002);
        // offset: 8; size: 16
        $data .= pack('VVVV', 0x00, 0x00, 0x00, 0x00);
        // offset: 24; size: 4; section count
        $data .= pack('V', 0x0001);
 
        // offset: 28; size: 16; first section's class id: 02 d5 cd d5 9c 2e 1b 10 93 97 08 00 2b 2c f9 ae
        $data .= pack('vvvvvvvv', 0xD502, 0xD5CD, 0x2E9C, 0x101B, 0x9793, 0x0008, 0x2C2B, 0xAEF9);
        // offset: 44; size: 4; offset of the start
        $data .= pack('V', 0x30);
 
        // SECTION
        $dataSection = [];
        $dataSection_NumProps = 0;
        $dataSection_Summary = '';
        $dataSection_Content = '';
 
        // GKPIDDSI_CODEPAGE: CodePage
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x01],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x02], // 2 byte signed integer
            'data' => ['data' => 1252],
        ];
        ++$dataSection_NumProps;
 
        // GKPIDDSI_CATEGORY : Category
        $dataProp = $this->spreadsheet->getProperties()->getCategory();
        if ($dataProp) {
            $dataSection[] = [
                'summary' => ['pack' => 'V', 'data' => 0x02],
                'offset' => ['pack' => 'V'],
                'type' => ['pack' => 'V', 'data' => 0x1E],
                'data' => ['data' => $dataProp, 'length' => strlen($dataProp)],
            ];
            ++$dataSection_NumProps;
        }
        // GKPIDDSI_VERSION :Version of the application that wrote the property storage
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x17],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x03],
            'data' => ['pack' => 'V', 'data' => 0x000C0000],
        ];
        ++$dataSection_NumProps;
        // GKPIDDSI_SCALE : FALSE
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x0B],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x0B],
            'data' => ['data' => false],
        ];
        ++$dataSection_NumProps;
        // GKPIDDSI_LINKSDIRTY : True if any of the values for the linked properties have changed outside of the application
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x10],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x0B],
            'data' => ['data' => false],
        ];
        ++$dataSection_NumProps;
        // GKPIDDSI_SHAREDOC : FALSE
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x13],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x0B],
            'data' => ['data' => false],
        ];
        ++$dataSection_NumProps;
        // GKPIDDSI_HYPERLINKSCHANGED : True if any of the values for the _PID_LINKS (hyperlink text) have changed outside of the application
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x16],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x0B],
            'data' => ['data' => false],
        ];
        ++$dataSection_NumProps;
 
        // GKPIDDSI_DOCSPARTS
        // MS-OSHARED p75 (2.3.3.2.2.1)
        // Structure is VtVecUnalignedLpstrValue (2.3.3.1.9)
        // cElements
        $dataProp = pack('v', 0x0001);
        $dataProp .= pack('v', 0x0000);
        // array of UnalignedLpstr
        // cch
        $dataProp .= pack('v', 0x000A);
        $dataProp .= pack('v', 0x0000);
        // value
        $dataProp .= 'Worksheet' . chr(0);
 
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x0D],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x101E],
            'data' => ['data' => $dataProp, 'length' => strlen($dataProp)],
        ];
        ++$dataSection_NumProps;
 
        // GKPIDDSI_HEADINGPAIR
        // VtVecHeadingPairValue
        // cElements
        $dataProp = pack('v', 0x0002);
        $dataProp .= pack('v', 0x0000);
        // Array of vtHeadingPair
        // vtUnalignedString - headingString
        // stringType
        $dataProp .= pack('v', 0x001E);
        // padding
        $dataProp .= pack('v', 0x0000);
        // UnalignedLpstr
        // cch
        $dataProp .= pack('v', 0x0013);
        $dataProp .= pack('v', 0x0000);
        // value
        $dataProp .= 'Feuilles de calcul';
        // vtUnalignedString - headingParts
        // wType : 0x0003 = 32 bit signed integer
        $dataProp .= pack('v', 0x0300);
        // padding
        $dataProp .= pack('v', 0x0000);
        // value
        $dataProp .= pack('v', 0x0100);
        $dataProp .= pack('v', 0x0000);
        $dataProp .= pack('v', 0x0000);
        $dataProp .= pack('v', 0x0000);
 
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x0C],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x100C],
            'data' => ['data' => $dataProp, 'length' => strlen($dataProp)],
        ];
        ++$dataSection_NumProps;
 
        //         4     Section Length
        //        4     Property count
        //        8 * $dataSection_NumProps (8 =  ID (4) + OffSet(4))
        $dataSection_Content_Offset = 8 + $dataSection_NumProps * 8;
        foreach ($dataSection as $dataProp) {
            // Summary
            $dataSection_Summary .= pack($dataProp['summary']['pack'], $dataProp['summary']['data']);
            // Offset
            $dataSection_Summary .= pack($dataProp['offset']['pack'], $dataSection_Content_Offset);
            // DataType
            $dataSection_Content .= pack($dataProp['type']['pack'], $dataProp['type']['data']);
            // Data
            if ($dataProp['type']['data'] == 0x02) { // 2 byte signed integer
                $dataSection_Content .= pack('V', $dataProp['data']['data']);
 
                $dataSection_Content_Offset += 4 + 4;
            } elseif ($dataProp['type']['data'] == 0x03) { // 4 byte signed integer
                $dataSection_Content .= pack('V', $dataProp['data']['data']);
 
                $dataSection_Content_Offset += 4 + 4;
            } elseif ($dataProp['type']['data'] == 0x0B) { // Boolean
                $dataSection_Content .= pack('V', (int) $dataProp['data']['data']);
                $dataSection_Content_Offset += 4 + 4;
            } elseif ($dataProp['type']['data'] == 0x1E) { // null-terminated string prepended by dword string length
                // Null-terminated string
                $dataProp['data']['data'] .= chr(0);
                // @phpstan-ignore-next-line
                ++$dataProp['data']['length'];
                // Complete the string with null string for being a %4
                $dataProp['data']['length'] = $dataProp['data']['length'] + ((4 - $dataProp['data']['length'] % 4) == 4 ? 0 : (4 - $dataProp['data']['length'] % 4));
                $dataProp['data']['data'] = str_pad($dataProp['data']['data'], $dataProp['data']['length'], chr(0), STR_PAD_RIGHT);
 
                $dataSection_Content .= pack('V', $dataProp['data']['length']);
                $dataSection_Content .= $dataProp['data']['data'];
 
                $dataSection_Content_Offset += 4 + 4 + strlen($dataProp['data']['data']);
            // Condition below can never be true
            //} elseif ($dataProp['type']['data'] == 0x40) { // Filetime (64-bit value representing the number of 100-nanosecond intervals since January 1, 1601)
            //    $dataSection_Content .= $dataProp['data']['data'];
 
            //    $dataSection_Content_Offset += 4 + 8;
            } else {
                $dataSection_Content .= $dataProp['data']['data'];
 
                // @phpstan-ignore-next-line
                $dataSection_Content_Offset += 4 + $dataProp['data']['length'];
            }
        }
        // Now $dataSection_Content_Offset contains the size of the content
 
        // section header
        // offset: $secOffset; size: 4; section length
        //         + x  Size of the content (summary + content)
        $data .= pack('V', $dataSection_Content_Offset);
        // offset: $secOffset+4; size: 4; property count
        $data .= pack('V', $dataSection_NumProps);
        // Section Summary
        $data .= $dataSection_Summary;
        // Section Content
        $data .= $dataSection_Content;
 
        return $data;
    }

References $data.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\save().

Here is the caller graph for this function:

◆ writeSummaryInformation()

PhpOffice\PhpSpreadsheet\Writer\Xls::writeSummaryInformation ( )

private

Build the OLE Part for Summary Information.

Returns: string

Definition at line 803 of file Xls.php.

    {
        // offset: 0; size: 2; must be 0xFE 0xFF (UTF-16 LE byte order mark)
        $data = pack('v', 0xFFFE);
        // offset: 2; size: 2;
        $data .= pack('v', 0x0000);
        // offset: 4; size: 2; OS version
        $data .= pack('v', 0x0106);
        // offset: 6; size: 2; OS indicator
        $data .= pack('v', 0x0002);
        // offset: 8; size: 16
        $data .= pack('VVVV', 0x00, 0x00, 0x00, 0x00);
        // offset: 24; size: 4; section count
        $data .= pack('V', 0x0001);
 
        // offset: 28; size: 16; first section's class id: e0 85 9f f2 f9 4f 68 10 ab 91 08 00 2b 27 b3 d9
        $data .= pack('vvvvvvvv', 0x85E0, 0xF29F, 0x4FF9, 0x1068, 0x91AB, 0x0008, 0x272B, 0xD9B3);
        // offset: 44; size: 4; offset of the start
        $data .= pack('V', 0x30);
 
        // SECTION
        $dataSection = [];
        $dataSection_NumProps = 0;
        $dataSection_Summary = '';
        $dataSection_Content = '';
 
        // CodePage : CP-1252
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x01],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x02], // 2 byte signed integer
            'data' => ['data' => 1252],
        ];
        ++$dataSection_NumProps;
 
        $props = $this->spreadsheet->getProperties();
        $this->writeSummaryProp($props->getTitle(), $dataSection_NumProps, $dataSection, 0x02, 0x1e);
        $this->writeSummaryProp($props->getSubject(), $dataSection_NumProps, $dataSection, 0x03, 0x1e);
        $this->writeSummaryProp($props->getCreator(), $dataSection_NumProps, $dataSection, 0x04, 0x1e);
        $this->writeSummaryProp($props->getKeywords(), $dataSection_NumProps, $dataSection, 0x05, 0x1e);
        $this->writeSummaryProp($props->getDescription(), $dataSection_NumProps, $dataSection, 0x06, 0x1e);
        $this->writeSummaryProp($props->getLastModifiedBy(), $dataSection_NumProps, $dataSection, 0x08, 0x1e);
        $this->writeSummaryPropOle($props->getCreated(), $dataSection_NumProps, $dataSection, 0x0c, 0x40);
        $this->writeSummaryPropOle($props->getModified(), $dataSection_NumProps, $dataSection, 0x0d, 0x40);
 
        //    Security
        $dataSection[] = [
            'summary' => ['pack' => 'V', 'data' => 0x13],
            'offset' => ['pack' => 'V'],
            'type' => ['pack' => 'V', 'data' => 0x03], // 4 byte signed integer
            'data' => ['data' => 0x00],
        ];
        ++$dataSection_NumProps;
 
        //         4     Section Length
        //        4     Property count
        //        8 * $dataSection_NumProps (8 =  ID (4) + OffSet(4))
        $dataSection_Content_Offset = 8 + $dataSection_NumProps * 8;
        foreach ($dataSection as $dataProp) {
            // Summary
            $dataSection_Summary .= pack($dataProp['summary']['pack'], $dataProp['summary']['data']);
            // Offset
            $dataSection_Summary .= pack($dataProp['offset']['pack'], $dataSection_Content_Offset);
            // DataType
            $dataSection_Content .= pack($dataProp['type']['pack'], $dataProp['type']['data']);
            // Data
            if ($dataProp['type']['data'] == 0x02) { // 2 byte signed integer
                $dataSection_Content .= pack('V', $dataProp['data']['data']);
 
                $dataSection_Content_Offset += 4 + 4;
            } elseif ($dataProp['type']['data'] == 0x03) { // 4 byte signed integer
                $dataSection_Content .= pack('V', $dataProp['data']['data']);
 
                $dataSection_Content_Offset += 4 + 4;
            } elseif ($dataProp['type']['data'] == 0x1E) { // null-terminated string prepended by dword string length
                // Null-terminated string
                $dataProp['data']['data'] .= chr(0);
                ++$dataProp['data']['length'];
                // Complete the string with null string for being a %4
                $dataProp['data']['length'] = $dataProp['data']['length'] + ((4 - $dataProp['data']['length'] % 4) == 4 ? 0 : (4 - $dataProp['data']['length'] % 4));
                $dataProp['data']['data'] = str_pad($dataProp['data']['data'], $dataProp['data']['length'], chr(0), STR_PAD_RIGHT);
 
                $dataSection_Content .= pack('V', $dataProp['data']['length']);
                $dataSection_Content .= $dataProp['data']['data'];
 
                $dataSection_Content_Offset += 4 + 4 + strlen($dataProp['data']['data']);
            } elseif ($dataProp['type']['data'] == 0x40) { // Filetime (64-bit value representing the number of 100-nanosecond intervals since January 1, 1601)
                $dataSection_Content .= $dataProp['data']['data'];
 
                $dataSection_Content_Offset += 4 + 8;
            }
            // Data Type Not Used at the moment
        }
        // Now $dataSection_Content_Offset contains the size of the content
 
        // section header
        // offset: $secOffset; size: 4; section length
        //         + x  Size of the content (summary + content)
        $data .= pack('V', $dataSection_Content_Offset);
        // offset: $secOffset+4; size: 4; property count
        $data .= pack('V', $dataSection_NumProps);
        // Section Summary
        $data .= $dataSection_Summary;
        // Section Content
        $data .= $dataSection_Content;
 
        return $data;
    }

References $data, PhpOffice\PhpSpreadsheet\Writer\Xls\writeSummaryProp(), and PhpOffice\PhpSpreadsheet\Writer\Xls\writeSummaryPropOle().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeSummaryProp()

PhpOffice\PhpSpreadsheet\Writer\Xls::writeSummaryProp	(	string	$dataProp,
		int &	$dataSection_NumProps,
		array &	$dataSection,
		int	$sumdata,
		int	$typdata
	)

private

Definition at line 785 of file Xls.php.

                                                                                                                                    : void
    {
        if ($dataProp) {
            $dataSection[] = [
                'summary' => ['pack' => 'V', 'data' => $sumdata],
                'offset' => ['pack' => 'V'],
                'type' => ['pack' => 'V', 'data' => $typdata], // null-terminated string prepended by dword string length
                'data' => ['data' => $dataProp, 'length' => strlen($dataProp)],
            ];
            ++$dataSection_NumProps;
        }
    }

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\writeSummaryInformation().

Here is the caller graph for this function:

◆ writeSummaryPropOle()

PhpOffice\PhpSpreadsheet\Writer\Xls::writeSummaryPropOle	(		$dataProp,
		int &	$dataSection_NumProps,
		array &	$dataSection,
		int	$sumdata,
		int	$typdata
	)

private

Parameters

float | int $dataProp

Definition at line 772 of file Xls.php.

                                                                                                                                : void
    {
        if ($dataProp) {
            $dataSection[] = [
                'summary' => ['pack' => 'V', 'data' => $sumdata],
                'offset' => ['pack' => 'V'],
                'type' => ['pack' => 'V', 'data' => $typdata], // null-terminated string prepended by dword string length
                'data' => ['data' => OLE::localDateToOLE($dataProp)],
            ];
            ++$dataSection_NumProps;
        }
    }

References PhpOffice\PhpSpreadsheet\Shared\OLE\localDateToOLE().

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\writeSummaryInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $colors

PhpOffice\PhpSpreadsheet\Writer\Xls::$colors

private

Definition at line 65 of file Xls.php.

◆ $documentSummaryInformation

PhpOffice\PhpSpreadsheet\Writer\Xls::$documentSummaryInformation

private

Definition at line 93 of file Xls.php.

◆ $IDCLs

PhpOffice\PhpSpreadsheet\Writer\Xls::$IDCLs

private

Definition at line 79 of file Xls.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\Escher\close().

◆ $parser

PhpOffice\PhpSpreadsheet\Writer\Xls::$parser

private

Definition at line 72 of file Xls.php.

◆ $spreadsheet

PhpOffice\PhpSpreadsheet\Writer\Xls::$spreadsheet

private

Definition at line 37 of file Xls.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Xls\__construct().

◆ $strTable

PhpOffice\PhpSpreadsheet\Writer\Xls::$strTable = []

private

Definition at line 58 of file Xls.php.

◆ $strTotal

PhpOffice\PhpSpreadsheet\Writer\Xls::$strTotal = 0

private

Definition at line 44 of file Xls.php.

◆ $strUnique

PhpOffice\PhpSpreadsheet\Writer\Xls::$strUnique = 0

private

Definition at line 51 of file Xls.php.

◆ $summaryInformation

PhpOffice\PhpSpreadsheet\Writer\Xls::$summaryInformation

private

Definition at line 86 of file Xls.php.

◆ $writerWorkbook

PhpOffice\PhpSpreadsheet\Writer\Xls::$writerWorkbook

private

Definition at line 98 of file Xls.php.

◆ $writerWorksheets

PhpOffice\PhpSpreadsheet\Writer\Xls::$writerWorksheets

private

Definition at line 103 of file Xls.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Writer/Xls.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildWorkbookEscher()

◆ buildWorksheetEschers()

◆ checkForDrawings()

◆ processBaseDrawing()

◆ processDrawing()

◆ processMemoryDrawing()

◆ save()

◆ writeDocumentSummaryInformation()

◆ writeSummaryInformation()

◆ writeSummaryProp()

◆ writeSummaryPropOle()

Field Documentation

◆ $colors

◆ $documentSummaryInformation

◆ $IDCLs

◆ $parser

◆ $spreadsheet

◆ $strTable

◆ $strTotal

◆ $strUnique

◆ $summaryInformation

◆ $writerWorkbook

◆ $writerWorksheets