PhpOffice\PhpSpreadsheet\Reader\Xlsx Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Reader\Xlsx:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Reader\Xlsx:

Public Member Functions
	__construct ()
	Create a new Xlsx Reader instance. More...
	canRead ($pFilename)
	Can the current IReader read the file? More...
	listWorksheetNames ($pFilename)
	Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object. More...
Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Reader\BaseReader
	__construct ()
	IReader constructor. More...
	getReadDataOnly ()
	Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting information. More...
	setReadDataOnly ($pValue)
	Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information. More...
	getReadEmptyCells ()
	Read empty cells? If this is true (the default), then the Reader will read data values for all cells, irrespective of value. More...
	setReadEmptyCells ($pValue)
	Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value. More...
	getIncludeCharts ()
	Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook. More...
	setIncludeCharts ($pValue)
	Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook. More...
	getLoadSheetsOnly ()
	Get which sheets to load Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null indicating that all worksheets in the workbook should be loaded. More...
	setLoadSheetsOnly ($value)
	Set which sheets to load. More...
	setLoadAllSheets ()
	Set all sheets to load Tells the Reader to load all worksheets from the workbook. More...
	getReadFilter ()
	Read filter. More...
	setReadFilter (IReadFilter $pValue)
	Set read filter. More...
	getSecurityScanner ()
Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Reader\IReader
	load ($pFilename)
	Loads PhpSpreadsheet from file. More...

Static Public Member Functions
static	stripWhiteSpaceFromStyleString ($string)

Private Member Functions
	castToFormula ($c, $r, &$cellDataType, &$value, &$calculatedValue, &$sharedFormulas, $castBaseType)
	getFromZipArchive (ZipArchive $archive, $fileName='')
	readRibbon (Spreadsheet $excel, $customUITarget, $zip)
	readHyperLinkDrawing ($objDrawing, $cellAnchor, $hyperlinks)
	readProtection (Spreadsheet $excel, SimpleXMLElement $xmlWorkbook)
	readFormControlProperties (Spreadsheet $excel, ZipArchive $zip, $dir, $fileWorksheet, $docSheet, array &$unparsedLoadedData)
	readPrinterSettings (Spreadsheet $excel, ZipArchive $zip, $dir, $fileWorksheet, $docSheet, array &$unparsedLoadedData)
	castXsdBooleanToBool ($xsdBoolean)
	Convert an 'xsd:boolean' XML value to a PHP boolean value. More...
	getWorkbookBaseName (ZipArchive $zip)
	readSheetProtection (Worksheet $docSheet, SimpleXMLElement $xmlSheet)

Static Private Member Functions
static	castToBoolean ($c)
static	castToError ($c)
static	castToString ($c)
static	readStyle (Style $docStyle, $style)
static	getArrayItem ($array, $key=0)
static	dirAdd ($base, $add)
static	toCSSArray ($style)
static	boolean ($value)
static	getLockValue (SimpleXmlElement $protection, string $key)

Private Attributes
	$referenceHelper

Static Private Attributes
static	$theme = null

Additional Inherited Members
Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Reader\BaseReader
	openFile ($pFilename)
	Open file for reading. More...
Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Reader\BaseReader
	$readDataOnly = false
	$readEmptyCells = true
	$includeCharts = false
	$loadSheetsOnly
	$readFilter
	$fileHandle
	$securityScanner

Detailed Description

Definition at line 41 of file Xlsx.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::__construct

(

)

Create a new Xlsx Reader instance.

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 60 of file Xlsx.php.

References PhpOffice\PhpSpreadsheet\ReferenceHelper\getInstance(), and PhpOffice\PhpSpreadsheet\Reader\Security\XmlScanner\getInstance().

    {
        parent::__construct();
        $this->referenceHelper = ReferenceHelper::getInstance();
        $this->securityScanner = XmlScanner::getInstance($this);
    }

Here is the call graph for this function:

Member Function Documentation

boolean()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::boolean (   $value )

staticprivate

Definition at line 1772 of file Xlsx.php.

    {
        if (is_object($value)) {
            $value = (string) $value;
        }
        if (is_numeric($value)) {
            return (bool) $value;
        }

        return $value === 'true' || $value === 'TRUE';
    }

canRead()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::canRead

(

$pFilename

)

Can the current IReader read the file?

Parameters

string

$pFilename

Returns

bool

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 74 of file Xlsx.php.

References $result, PhpOffice\PhpSpreadsheet\Shared\File\assertFile(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\getWorkbookBaseName().

    {
        File::assertFile($pFilename);

        $result = false;
        $zip = new ZipArchive();

        if ($zip->open($pFilename) === true) {
            $workbookBasename = $this->getWorkbookBaseName($zip);
            $result = !empty($workbookBasename);

            $zip->close();
        }

        return $result;
    }

Here is the call graph for this function:

castToBoolean()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::castToBoolean (   $c )

staticprivate

Definition at line 238 of file Xlsx.php.

References $c, and if.

    {
        $value = isset($c->v) ? (string) $c->v : null;
        if ($value == '0') {
            return false;
        } elseif ($value == '1') {
            return true;
        }

        return (bool) $c->v;
    }

castToError()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::castToError (   $c )

staticprivate

Definition at line 250 of file Xlsx.php.

References $c.

    {
        return isset($c->v) ? (string) $c->v : null;
    }

castToFormula()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::castToFormula (   $c,   $r, &  $cellDataType, &  $value, &  $calculatedValue, &  $sharedFormulas,   $castBaseType  )

private

Definition at line 260 of file Xlsx.php.

References $c, $current, $r, if, and PhpOffice\PhpSpreadsheet\Cell\Coordinate\indexesFromString().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

                                                                                                                       : void
    {
        $cellDataType = 'f';
        $value = "={$c->f}";
        $calculatedValue = self::$castBaseType($c);

        // Shared formula?
        if (isset($c->f['t']) && strtolower((string) $c->f['t']) == 'shared') {
            $instance = (string) $c->f['si'];

            if (!isset($sharedFormulas[(string) $c->f['si']])) {
                $sharedFormulas[$instance] = ['master' => $r, 'formula' => $value];
            } else {
                $master = Coordinate::indexesFromString($sharedFormulas[$instance]['master']);
                $current = Coordinate::indexesFromString($r);

                $difference = [0, 0];
                $difference[0] = $current[0] - $master[0];
                $difference[1] = $current[1] - $master[1];

                $value = $this->referenceHelper->updateFormulaReferences($sharedFormulas[$instance]['formula'], 'A1', $difference[0], $difference[1]);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

castToString()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::castToString (   $c )

staticprivate

Definition at line 255 of file Xlsx.php.

References $c.

    {
        return isset($c->v) ? (string) $c->v : null;
    }

castXsdBooleanToBool()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::castXsdBooleanToBool (   $xsdBoolean )

private

Convert an 'xsd:boolean' XML value to a PHP boolean value.

A valid 'xsd:boolean' XML value can be one of the following four values: 'true', 'false', '1', '0'. It is case sensitive.

Note that just doing '(bool) $xsdBoolean' is not safe, since '(bool) "false"' returns true.

See also

https://www.w3.org/TR/xmlschema11-2/#boolean

Parameters

string

$xsdBoolean

An XML string value of type 'xsd:boolean'

Returns

bool Boolean value

Definition at line 1920 of file Xlsx.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

    {
        if ($xsdBoolean === 'false') {
            return false;
        }

        return (bool) $xsdBoolean;
    }

Here is the caller graph for this function:

dirAdd()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::dirAdd (   $base,   $add  )

staticprivate

Definition at line 1731 of file Xlsx.php.

References $base.

    {
        return preg_replace('~[^/]+/\.\./~', '', dirname($base) . "/$add");
    }

getArrayItem()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::getArrayItem (   $array,   $key = 0  )

staticprivate

Definition at line 1726 of file Xlsx.php.

References $key.

    {
        return $array[$key] ?? null;
    }

getFromZipArchive()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::getFromZipArchive ( ZipArchive  $archive,   $fileName = ''  )

private

Parameters

string

$fileName

Returns

string

Definition at line 290 of file Xlsx.php.

References $attributes, $c, $comment, $contentType, $key, $r, $row, $style, PhpOffice\PhpSpreadsheet\Shared\Drawing\angleToDegrees(), PhpOffice\PhpSpreadsheet\Shared\File\assertFile(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\builtInFormatCode(), PhpOffice\PhpSpreadsheet\Shared\Date\CALENDAR_MAC_1904, PhpOffice\PhpSpreadsheet\Shared\Date\CALENDAR_WINDOWS_1900, PhpOffice\PhpSpreadsheet\Reader\Xlsx\castToFormula(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\castXsdBooleanToBool(), PhpOffice\PhpSpreadsheet\Shared\StringHelper\controlCharacterOOXML2PHP(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\coordinateFromString(), PhpOffice\PhpSpreadsheet\DefinedName\createInstance(), PhpOffice\PhpSpreadsheet\Shared\Drawing\EMUToPixels(), PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\extractSheetTitle(), PhpOffice\PhpSpreadsheet\Style\NumberFormat\FORMAT_GENERAL, PhpOffice\PhpSpreadsheet\Settings\getLibXmlLoaderOptions(), PhpOffice\PhpSpreadsheet\Reader\BaseReader\getReadDataOnly(), PhpOffice\PhpSpreadsheet\Reader\BaseReader\getReadFilter(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\getWorkbookBaseName(), PhpOffice\PhpSpreadsheet\Reader\IReader\load(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Chart\readChart(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\readFormControlProperties(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\readHyperLinkDrawing(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\readPrinterSettings(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\readProtection(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\readRibbon(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\readSheetProtection(), PhpOffice\PhpSpreadsheet\Shared\File\realpath(), PhpOffice\PhpSpreadsheet\Shared\Date\setExcelCalendar(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex(), PhpOffice\PhpSpreadsheet\DefinedName\testIfFormula(), PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_NUMERIC, and PhpOffice\PhpSpreadsheet\Cell\DataType\TYPE_STRING.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\readFormControlProperties(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\readPrinterSettings(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\readRibbon().

    {
        // Root-relative paths
        if (strpos($fileName, '//') !== false) {
            $fileName = substr($fileName, strpos($fileName, '//') + 1);
        }
        $fileName = File::realpath($fileName);

        // Sadly, some 3rd party xlsx generators don't use consistent case for filenaming
        //    so we need to load case-insensitively from the zip file

        // Apache POI fixes
        $contents = $archive->getFromName($fileName, 0, ZipArchive::FL_NOCASE);
        if ($contents === false) {
            $contents = $archive->getFromName(substr($fileName, 1), 0, ZipArchive::FL_NOCASE);
        }

        return $contents;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLockValue()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::getLockValue ( SimpleXmlElement  $protection, string  $key  )

staticprivate

Definition at line 1830 of file Xlsx.php.

References $key.

                                                                                   : ?bool
    {
        $returnValue = null;
        $protectKey = $protection[$key];
        if (!empty($protectKey)) {
            $protectKey = (string) $protectKey;
            $returnValue = $protectKey !== 'false' && (bool) $protectKey;
        }

        return $returnValue;
    }

getWorkbookBaseName()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::getWorkbookBaseName ( ZipArchive  $zip )

private

Parameters

ZipArchive

$zip

Opened zip archive

Returns

string basename of the used excel workbook

Definition at line 1934 of file Xlsx.php.

References PhpOffice\PhpSpreadsheet\Settings\getLibXmlLoaderOptions().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\canRead(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

    {
        $workbookBasename = '';

        // check if it is an OOXML archive
        $rels = simplexml_load_string(
            $this->securityScanner->scan(
                $this->getFromZipArchive($zip, '_rels/.rels')
            ),
            'SimpleXMLElement',
            Settings::getLibXmlLoaderOptions()
        );
        if ($rels !== false) {
            foreach ($rels->Relationship as $rel) {
                switch ($rel['Type']) {
                    case 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument':
                        $basename = basename($rel['Target']);
                        if (preg_match('/workbook.*\.xml/', $basename)) {
                            $workbookBasename = $basename;
                        }

                        break;
                }
            }
        }

        return $workbookBasename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listWorksheetNames()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::listWorksheetNames

(

$pFilename

)

Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object.

Parameters

string

$pFilename

Returns

array

Definition at line 98 of file Xlsx.php.

References $row, $xml, PhpOffice\PhpSpreadsheet\Shared\File\assertFile(), PhpOffice\PhpSpreadsheet\Settings\getLibXmlLoaderOptions(), PhpOffice\PhpSpreadsheet\Shared\File\realpath(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

    {
        File::assertFile($pFilename);

        $worksheetNames = [];

        $zip = new ZipArchive();
        $zip->open($pFilename);

        //    The files we're looking at here are small enough that simpleXML is more efficient than XMLReader
        //~ http://schemas.openxmlformats.org/package/2006/relationships");
        $rels = simplexml_load_string(
            $this->securityScanner->scan($this->getFromZipArchive($zip, '_rels/.rels'))
        );
        foreach ($rels->Relationship as $rel) {
            switch ($rel['Type']) {
                case 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument':
                    //~ http://schemas.openxmlformats.org/spreadsheetml/2006/main"
                    $xmlWorkbook = simplexml_load_string(
                        $this->securityScanner->scan($this->getFromZipArchive($zip, "{$rel['Target']}"))
                    );

                    if ($xmlWorkbook->sheets) {
                        foreach ($xmlWorkbook->sheets->sheet as $eleSheet) {
                            // Check if sheet should be skipped
                            $worksheetNames[] = (string) $eleSheet['name'];
                        }
                    }
            }
        }

        $zip->close();

        return $worksheetNames;
    }

Here is the call graph for this function:

readFormControlProperties()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::readFormControlProperties ( Spreadsheet  $excel, ZipArchive  $zip,   $dir,   $fileWorksheet,   $docSheet, array &  $unparsedLoadedData  )

private

Definition at line 1842 of file Xlsx.php.

References PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), and PhpOffice\PhpSpreadsheet\Settings\getLibXmlLoaderOptions().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

                                                                                                                                                : void
    {
        if (!$zip->locateName(dirname("$dir/$fileWorksheet") . '/_rels/' . basename($fileWorksheet) . '.rels')) {
            return;
        }

        //~ http://schemas.openxmlformats.org/package/2006/relationships"
        $relsWorksheet = simplexml_load_string(
            $this->securityScanner->scan(
                $this->getFromZipArchive($zip, dirname("$dir/$fileWorksheet") . '/_rels/' . basename($fileWorksheet) . '.rels')
            ),
            'SimpleXMLElement',
            Settings::getLibXmlLoaderOptions()
        );
        $ctrlProps = [];
        foreach ($relsWorksheet->Relationship as $ele) {
            if ($ele['Type'] == 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/ctrlProp') {
                $ctrlProps[(string) $ele['Id']] = $ele;
            }
        }

        $unparsedCtrlProps = &$unparsedLoadedData['sheets'][$docSheet->getCodeName()]['ctrlProps'];
        foreach ($ctrlProps as $rId => $ctrlProp) {
            $rId = substr($rId, 3); // rIdXXX
            $unparsedCtrlProps[$rId] = [];
            $unparsedCtrlProps[$rId]['filePath'] = self::dirAdd("$dir/$fileWorksheet", $ctrlProp['Target']);
            $unparsedCtrlProps[$rId]['relFilePath'] = (string) $ctrlProp['Target'];
            $unparsedCtrlProps[$rId]['content'] = $this->securityScanner->scan($this->getFromZipArchive($zip, $unparsedCtrlProps[$rId]['filePath']));
        }
        unset($unparsedCtrlProps);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readHyperLinkDrawing()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::readHyperLinkDrawing (   $objDrawing,   $cellAnchor,   $hyperlinks  )

private

Parameters

\PhpOffice\PhpSpreadsheet\Worksheet\Drawing	$objDrawing
SimpleXMLElement	$cellAnchor
array	$hyperlinks

Definition at line 1789 of file Xlsx.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

                                                                                : void
    {
        $hlinkClick = $cellAnchor->pic->nvPicPr->cNvPr->children('http://schemas.openxmlformats.org/drawingml/2006/main')->hlinkClick;

        if ($hlinkClick->count() === 0) {
            return;
        }

        $hlinkId = (string) $hlinkClick->attributes('http://schemas.openxmlformats.org/officeDocument/2006/relationships')['id'];
        $hyperlink = new Hyperlink(
            $hyperlinks[$hlinkId],
            (string) self::getArrayItem($cellAnchor->pic->nvPicPr->cNvPr->attributes(), 'name')
        );
        $objDrawing->setHyperlink($hyperlink);
    }

Here is the caller graph for this function:

readPrinterSettings()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::readPrinterSettings ( Spreadsheet  $excel, ZipArchive  $zip,   $dir,   $fileWorksheet,   $docSheet, array &  $unparsedLoadedData  )

private

Definition at line 1874 of file Xlsx.php.

References PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), and PhpOffice\PhpSpreadsheet\Settings\getLibXmlLoaderOptions().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

                                                                                                                                          : void
    {
        if (!$zip->locateName(dirname("$dir/$fileWorksheet") . '/_rels/' . basename($fileWorksheet) . '.rels')) {
            return;
        }

        //~ http://schemas.openxmlformats.org/package/2006/relationships"
        $relsWorksheet = simplexml_load_string(
            $this->securityScanner->scan(
                $this->getFromZipArchive($zip, dirname("$dir/$fileWorksheet") . '/_rels/' . basename($fileWorksheet) . '.rels')
            ),
            'SimpleXMLElement',
            Settings::getLibXmlLoaderOptions()
        );
        $sheetPrinterSettings = [];
        foreach ($relsWorksheet->Relationship as $ele) {
            if ($ele['Type'] == 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/printerSettings') {
                $sheetPrinterSettings[(string) $ele['Id']] = $ele;
            }
        }

        $unparsedPrinterSettings = &$unparsedLoadedData['sheets'][$docSheet->getCodeName()]['printerSettings'];
        foreach ($sheetPrinterSettings as $rId => $printerSettings) {
            $rId = substr($rId, 3) . 'ps'; // rIdXXX, add 'ps' suffix to avoid identical resource identifier collision with unparsed vmlDrawing
            $unparsedPrinterSettings[$rId] = [];
            $unparsedPrinterSettings[$rId]['filePath'] = self::dirAdd("$dir/$fileWorksheet", $printerSettings['Target']);
            $unparsedPrinterSettings[$rId]['relFilePath'] = (string) $printerSettings['Target'];
            $unparsedPrinterSettings[$rId]['content'] = $this->securityScanner->scan($this->getFromZipArchive($zip, $unparsedPrinterSettings[$rId]['filePath']));
        }
        unset($unparsedPrinterSettings);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readProtection()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::readProtection ( Spreadsheet  $excel, SimpleXMLElement  $xmlWorkbook  )

private

Definition at line 1805 of file Xlsx.php.

References PhpOffice\PhpSpreadsheet\Spreadsheet\getSecurity().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

                                                                                      : void
    {
        if (!$xmlWorkbook->workbookProtection) {
            return;
        }

        $excel->getSecurity()->setLockRevision(self::getLockValue($xmlWorkbook->workbookProtection, 'lockRevision'));
        $excel->getSecurity()->setLockStructure(self::getLockValue($xmlWorkbook->workbookProtection, 'lockStructure'));
        $excel->getSecurity()->setLockWindows(self::getLockValue($xmlWorkbook->workbookProtection, 'lockWindows'));

        if ($xmlWorkbook->workbookProtection['revisionsPassword']) {
            $excel->getSecurity()->setRevisionsPassword(
                (string) $xmlWorkbook->workbookProtection['revisionsPassword'],
                true
            );
        }

        if ($xmlWorkbook->workbookProtection['workbookPassword']) {
            $excel->getSecurity()->setWorkbookPassword(
                (string) $xmlWorkbook->workbookProtection['workbookPassword'],
                true
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readRibbon()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::readRibbon ( Spreadsheet  $excel,   $customUITarget,   $zip  )

private

Parameters

mixed	$customUITarget
mixed	$zip

Definition at line 1684 of file Xlsx.php.

References $baseDir, PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive(), PhpOffice\PhpSpreadsheet\Settings\getLibXmlLoaderOptions(), PhpOffice\PhpSpreadsheet\Spreadsheet\setRibbonBinObjects(), and PhpOffice\PhpSpreadsheet\Spreadsheet\setRibbonXMLData().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

                                                                          : void
    {
        $baseDir = dirname($customUITarget);
        $nameCustomUI = basename($customUITarget);
        // get the xml file (ribbon)
        $localRibbon = $this->getFromZipArchive($zip, $customUITarget);
        $customUIImagesNames = [];
        $customUIImagesBinaries = [];
        // something like customUI/_rels/customUI.xml.rels
        $pathRels = $baseDir . '/_rels/' . $nameCustomUI . '.rels';
        $dataRels = $this->getFromZipArchive($zip, $pathRels);
        if ($dataRels) {
            // exists and not empty if the ribbon have some pictures (other than internal MSO)
            $UIRels = simplexml_load_string(
                $this->securityScanner->scan($dataRels),
                'SimpleXMLElement',
                Settings::getLibXmlLoaderOptions()
            );
            if (false !== $UIRels) {
                // we need to save id and target to avoid parsing customUI.xml and "guess" if it's a pseudo callback who load the image
                foreach ($UIRels->Relationship as $ele) {
                    if ($ele['Type'] == 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image') {
                        // an image ?
                        $customUIImagesNames[(string) $ele['Id']] = (string) $ele['Target'];
                        $customUIImagesBinaries[(string) $ele['Target']] = $this->getFromZipArchive($zip, $baseDir . '/' . (string) $ele['Target']);
                    }
                }
            }
        }
        if ($localRibbon) {
            $excel->setRibbonXMLData($customUITarget, $localRibbon);
            if (count($customUIImagesNames) > 0 && count($customUIImagesBinaries) > 0) {
                $excel->setRibbonBinObjects($customUIImagesNames, $customUIImagesBinaries);
            } else {
                $excel->setRibbonBinObjects(null, null);
            }
        } else {
            $excel->setRibbonXMLData(null, null);
            $excel->setRibbonBinObjects(null, null);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readSheetProtection()

PhpOffice\PhpSpreadsheet\Reader\Xlsx::readSheetProtection ( Worksheet  $docSheet, SimpleXMLElement  $xmlSheet  )

private

Definition at line 1963 of file Xlsx.php.

References PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\getProtection(), and PhpOffice\PhpSpreadsheet\Worksheet\Worksheet\protectCells().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

                                                                                         : void
    {
        if ($this->readDataOnly || !$xmlSheet->sheetProtection) {
            return;
        }

        $algorithmName = (string) $xmlSheet->sheetProtection['algorithmName'];
        $protection = $docSheet->getProtection();
        $protection->setAlgorithm($algorithmName);

        if ($algorithmName) {
            $protection->setPassword((string) $xmlSheet->sheetProtection['hashValue'], true);
            $protection->setSalt((string) $xmlSheet->sheetProtection['saltValue']);
            $protection->setSpinCount((int) $xmlSheet->sheetProtection['spinCount']);
        } else {
            $protection->setPassword((string) $xmlSheet->sheetProtection['password'], true);
        }

        if ($xmlSheet->protectedRanges->protectedRange) {
            foreach ($xmlSheet->protectedRanges->protectedRange as $protectedRange) {
                $docSheet->protectCells((string) $protectedRange['sqref'], (string) $protectedRange['password'], true);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readStyle()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::readStyle ( Style  $docStyle,   $style  )

staticprivate

Parameters

SimpleXMLElement | stdClass

$style

Definition at line 1574 of file Xlsx.php.

References $style, PhpOffice\PhpSpreadsheet\Shared\StringHelper\controlCharacterOOXML2PHP(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readAlignmentStyle(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readBorderStyle(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readColor(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readFontStyle(), PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readProtectionHidden(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\Styles\readProtectionLocked().

                                                              : void
    {
        $docStyle->getNumberFormat()->setFormatCode($style->numFmt);

        // font
        if (isset($style->font)) {
            Styles::readFontStyle($docStyle->getFont(), $style->font);
        }

        // fill
        if (isset($style->fill)) {
            Styles::readFillStyle($docStyle->getFill(), $style->fill);
        }

        // border
        if (isset($style->border)) {
            Styles::readBorderStyle($docStyle->getBorders(), $style->border);
        }

        // alignment
        if (isset($style->alignment)) {
            Styles::readAlignmentStyle($docStyle->getAlignment(), $style->alignment);
        }

        // protection
        if (isset($style->protection)) {
            Styles::readProtectionLocked($docStyle, $style->protection);
            Styles::readProtectionHidden($docStyle, $style->protection);
        }

        // top-level style settings
        if (isset($style->quotePrefix)) {
            $docStyle->setQuotePrefix((bool) $style->quotePrefix);
        }
    }

Here is the call graph for this function:

stripWhiteSpaceFromStyleString()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::stripWhiteSpaceFromStyleString (   $string )

static

Definition at line 1767 of file Xlsx.php.

    {
        return trim(str_replace(["\r", "\n", ' '], '', $string), ';');
    }

toCSSArray()

static PhpOffice\PhpSpreadsheet\Reader\Xlsx::toCSSArray (   $style )

staticprivate

Definition at line 1736 of file Xlsx.php.

References $style, PhpOffice\PhpSpreadsheet\Shared\Font\centimeterSizeToPixels(), PhpOffice\PhpSpreadsheet\Shared\Font\fontSizeToPixels(), and PhpOffice\PhpSpreadsheet\Shared\Font\inchSizeToPixels().

    {
        $style = self::stripWhiteSpaceFromStyleString($style);

        $temp = explode(';', $style);
        $style = [];
        foreach ($temp as $item) {
            $item = explode(':', $item);

            if (strpos($item[1], 'px') !== false) {
                $item[1] = str_replace('px', '', $item[1]);
            }
            if (strpos($item[1], 'pt') !== false) {
                $item[1] = str_replace('pt', '', $item[1]);
                $item[1] = Font::fontSizeToPixels($item[1]);
            }
            if (strpos($item[1], 'in') !== false) {
                $item[1] = str_replace('in', '', $item[1]);
                $item[1] = Font::inchSizeToPixels($item[1]);
            }
            if (strpos($item[1], 'cm') !== false) {
                $item[1] = str_replace('cm', '', $item[1]);
                $item[1] = Font::centimeterSizeToPixels($item[1]);
            }

            $style[$item[0]] = $item[1];
        }

        return $style;
    }

Here is the call graph for this function:

Field Documentation

$referenceHelper

PhpOffice\PhpSpreadsheet\Reader\Xlsx::$referenceHelper

private

Definition at line 48 of file Xlsx.php.

$theme

PhpOffice\PhpSpreadsheet\Reader\Xlsx::$theme = null

staticprivate

Definition at line 55 of file Xlsx.php.

---

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

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Reader/Xlsx.php