PhpOffice\PhpSpreadsheet\Reader\Xml Class Reference

Reader for SpreadsheetML, the XML schema for Microsoft Office Excel 2003. More...

Inheritance diagram for PhpOffice\PhpSpreadsheet\Reader\Xml:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Reader\Xml:

Public Member Functions
	__construct ()
	Create a new Excel2003XML Reader instance. More...
	canRead ($pFilename)
	Can the current IReader read the file? More...
	trySimpleXMLLoadString ($pFilename)
	Check if the file is a valid SimpleXML. More...
	listWorksheetNames ($filename)
	Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object. More...
	listWorksheetInfo ($filename)
	Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). More...
	load ($filename)
	Loads Spreadsheet from file. 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 ()
	__construct ()
	IReader constructor. More...
	canRead ($pFilename)
	Can the current IReader read the file? 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...
	load ($pFilename)
	Loads PhpSpreadsheet from file. More...

Static Public Member Functions
static	xmlMappings ()

Protected Member Functions
	parseCellComment (SimpleXMLElement $comment, array $namespaces, Spreadsheet $spreadsheet, string $columnID, int $rowID)
	parseRichText (string $annotation)
Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Reader\BaseReader
	openFile ($pFilename)
	Open file for reading. More...

Protected Attributes
	$styles = []
Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Reader\BaseReader
	$readDataOnly = false
	$readEmptyCells = true
	$includeCharts = false
	$loadSheetsOnly
	$readFilter
	$fileHandle
	$securityScanner

Static Private Member Functions
static	getAttributes (?SimpleXMLElement $simple, string $node)

Private Attributes
	$fileContents = ''

Detailed Description

Reader for SpreadsheetML, the XML schema for Microsoft Office Excel 2003.

Definition at line 26 of file Xml.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Reader\Xml::__construct

(

)

Create a new Excel2003XML Reader instance.

Reimplemented from PhpOffice\PhpSpreadsheet\Reader\BaseReader.

Definition at line 38 of file Xml.php.

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

References PhpOffice\PhpSpreadsheet\Reader\Security\XmlScanner\getInstance().

Here is the call graph for this function:

Member Function Documentation

canRead()

PhpOffice\PhpSpreadsheet\Reader\Xml::canRead

(

$pFilename

)

Can the current IReader read the file?

Parameters

string

$pFilename

Returns

bool

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 61 of file Xml.php.

    {
        //    Office                    xmlns:o="urn:schemas-microsoft-com:office:office"
        //    Excel                    xmlns:x="urn:schemas-microsoft-com:office:excel"
        //    XML Spreadsheet            xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet"
        //    Spreadsheet component    xmlns:c="urn:schemas-microsoft-com:office:component:spreadsheet"
        //    XML schema                 xmlns:s="uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882"
        //    XML data type            xmlns:dt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882"
        //    MS-persist recordset    xmlns:rs="urn:schemas-microsoft-com:rowset"
        //    Rowset                    xmlns:z="#RowsetSchema"
        //
 
        $signature = [
            '<?xml version="1.0"',
            'xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet',
        ];
 
        // Open file
        $data = file_get_contents($pFilename);
 
        // Why?
        //$data = str_replace("'", '"', $data); // fix headers with single quote
 
        $valid = true;
        foreach ($signature as $match) {
            // every part of the signature must be present
            if (strpos($data, $match) === false) {
                $valid = false;
 
                break;
            }
        }
 
        //    Retrieve charset encoding
        if (preg_match('/<?xml.*encoding=[\'"](.*?)[\'"].*?>/m', $data, $matches)) {
            $charSet = strtoupper($matches[1]);
            if (1 == preg_match('/^ISO-8859-\d[\dL]?$/i', $charSet)) {
                $data = StringHelper::convertEncoding($data, 'UTF-8', $charSet);
                $data = preg_replace('/(<?xml.*encoding=[\'"]).*?([\'"].*?>)/um', '$1' . 'UTF-8' . '$2', $data, 1);
            }
        }
        $this->fileContents = $data;
 
        return $valid;
    }

References $data, $valid, and PhpOffice\PhpSpreadsheet\Shared\StringHelper\convertEncoding().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetInfo(), and PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetNames().

Here is the call graph for this function:

Here is the caller graph for this function:

getAttributes()

static PhpOffice\PhpSpreadsheet\Reader\Xml::getAttributes ( ?SimpleXMLElement  $simple, string  $node  )

staticprivate

Definition at line 534 of file Xml.php.

                                                                                  : SimpleXMLElement
    {
        return ($simple === null)
            ? new SimpleXMLElement('<xml></xml>')
            : ($simple->attributes($node) ?? new SimpleXMLElement('<xml></xml>'));
    }

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetInfo(), and PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetNames().

Here is the caller graph for this function:

listWorksheetInfo()

PhpOffice\PhpSpreadsheet\Reader\Xml::listWorksheetInfo

(

$filename

)

Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).

Parameters

string

$filename

Returns

array

Definition at line 169 of file Xml.php.

    {
        File::assertFile($filename);
        if (!$this->canRead($filename)) {
            throw new Exception($filename . ' is an Invalid Spreadsheet file.');
        }
 
        $worksheetInfo = [];
 
        $xml = $this->trySimpleXMLLoadString($filename);
        if ($xml === false) {
            throw new Exception("Problem reading {$filename}");
        }
 
        $namespaces = $xml->getNamespaces(true);
 
        $worksheetID = 1;
        $xml_ss = $xml->children($namespaces['ss']);
        foreach ($xml_ss->Worksheet as $worksheet) {
            $worksheet_ss = self::getAttributes($worksheet, $namespaces['ss']);
 
            $tmpInfo = [];
            $tmpInfo['worksheetName'] = '';
            $tmpInfo['lastColumnLetter'] = 'A';
            $tmpInfo['lastColumnIndex'] = 0;
            $tmpInfo['totalRows'] = 0;
            $tmpInfo['totalColumns'] = 0;
 
            $tmpInfo['worksheetName'] = "Worksheet_{$worksheetID}";
            if (isset($worksheet_ss['Name'])) {
                $tmpInfo['worksheetName'] = (string) $worksheet_ss['Name'];
            }
 
            if (isset($worksheet->Table->Row)) {
                $rowIndex = 0;
 
                foreach ($worksheet->Table->Row as $rowData) {
                    $columnIndex = 0;
                    $rowHasData = false;
 
                    foreach ($rowData->Cell as $cell) {
                        if (isset($cell->Data)) {
                            $tmpInfo['lastColumnIndex'] = max($tmpInfo['lastColumnIndex'], $columnIndex);
                            $rowHasData = true;
                        }
 
                        ++$columnIndex;
                    }
 
                    ++$rowIndex;
 
                    if ($rowHasData) {
                        $tmpInfo['totalRows'] = max($tmpInfo['totalRows'], $rowIndex);
                    }
                }
            }
 
            $tmpInfo['lastColumnLetter'] = Coordinate::stringFromColumnIndex($tmpInfo['lastColumnIndex'] + 1);
            $tmpInfo['totalColumns'] = $tmpInfo['lastColumnIndex'] + 1;
 
            $worksheetInfo[] = $tmpInfo;
            ++$worksheetID;
        }
 
        return $worksheetInfo;
    }

References $filename, $xml, PhpOffice\PhpSpreadsheet\Shared\File\assertFile(), PhpOffice\PhpSpreadsheet\Reader\Xml\canRead(), PhpOffice\PhpSpreadsheet\Reader\Xml\getAttributes(), PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex(), and PhpOffice\PhpSpreadsheet\Reader\Xml\trySimpleXMLLoadString().

Here is the call graph for this function:

listWorksheetNames()

PhpOffice\PhpSpreadsheet\Reader\Xml::listWorksheetNames

(

$filename

)

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

Parameters

string

$filename

Returns

array

Definition at line 137 of file Xml.php.

    {
        File::assertFile($filename);
        if (!$this->canRead($filename)) {
            throw new Exception($filename . ' is an Invalid Spreadsheet file.');
        }
 
        $worksheetNames = [];
 
        $xml = $this->trySimpleXMLLoadString($filename);
        if ($xml === false) {
            throw new Exception("Problem reading {$filename}");
        }
 
        $namespaces = $xml->getNamespaces(true);
 
        $xml_ss = $xml->children($namespaces['ss']);
        foreach ($xml_ss->Worksheet as $worksheet) {
            $worksheet_ss = self::getAttributes($worksheet, $namespaces['ss']);
            $worksheetNames[] = (string) $worksheet_ss['Name'];
        }
 
        return $worksheetNames;
    }

References $filename, $xml, PhpOffice\PhpSpreadsheet\Shared\File\assertFile(), PhpOffice\PhpSpreadsheet\Reader\Xml\canRead(), PhpOffice\PhpSpreadsheet\Reader\Xml\getAttributes(), and PhpOffice\PhpSpreadsheet\Reader\Xml\trySimpleXMLLoadString().

Here is the call graph for this function:

load()

PhpOffice\PhpSpreadsheet\Reader\Xml::load

(

$filename

)

Loads Spreadsheet from file.

Parameters

string

$filename

Returns

Spreadsheet

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 243 of file Xml.php.

    {
        // Create new Spreadsheet
        $spreadsheet = new Spreadsheet();
        $spreadsheet->removeSheetByIndex(0);
 
        // Load into this instance
        return $this->loadIntoExisting($filename, $spreadsheet);
    }

References $filename.

parseCellComment()

PhpOffice\PhpSpreadsheet\Reader\Xml::parseCellComment ( SimpleXMLElement  $comment, array  $namespaces, Spreadsheet  $spreadsheet, string  $columnID, int  $rowID  )

protected

Definition at line 505 of file Xml.php.

     : void {
        $commentAttributes = $comment->attributes($namespaces['ss']);
        $author = 'unknown';
        if (isset($commentAttributes->Author)) {
            $author = (string) $commentAttributes->Author;
        }
 
        $node = $comment->Data->asXML();
        $annotation = strip_tags((string) $node);
        $spreadsheet->getActiveSheet()->getComment($columnID . $rowID)
            ->setAuthor($author)
            ->setText($this->parseRichText($annotation));
    }

parseRichText()

PhpOffice\PhpSpreadsheet\Reader\Xml::parseRichText ( string  $annotation )

protected

Definition at line 525 of file Xml.php.

                                                        : RichText
    {
        $value = new RichText();
 
        $value->createText($annotation);
 
        return $value;
    }

trySimpleXMLLoadString()

PhpOffice\PhpSpreadsheet\Reader\Xml::trySimpleXMLLoadString

(

$pFilename

)

Check if the file is a valid SimpleXML.

Parameters

string

$pFilename

Returns

false|SimpleXMLElement

Definition at line 114 of file Xml.php.

    {
        try {
            $xml = simplexml_load_string(
                $this->securityScanner->scan($this->fileContents ?: file_get_contents($pFilename)),
                'SimpleXMLElement',
                Settings::getLibXmlLoaderOptions()
            );
        } catch (\Exception $e) {
            throw new Exception('Cannot load invalid XML file: ' . $pFilename, 0, $e);
        }
        $this->fileContents = '';
 
        return $xml;
    }

References $xml, and PhpOffice\PhpSpreadsheet\Settings\getLibXmlLoaderOptions().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetInfo(), and PhpOffice\PhpSpreadsheet\Reader\Xml\listWorksheetNames().

Here is the call graph for this function:

Here is the caller graph for this function:

xmlMappings()

static PhpOffice\PhpSpreadsheet\Reader\Xml::xmlMappings ( )

static

Definition at line 46 of file Xml.php.

                                        : array
    {
        return array_merge(
            Style\Fill::FILL_MAPPINGS,
            Style\Border::BORDER_MAPPINGS
        );
    }

References PhpOffice\PhpSpreadsheet\Reader\Xml\Style\Border\BORDER_MAPPINGS, and PhpOffice\PhpSpreadsheet\Reader\Xml\Style\Fill\FILL_MAPPINGS.

Field Documentation

$fileContents

PhpOffice\PhpSpreadsheet\Reader\Xml::$fileContents = ''

private

Definition at line 44 of file Xml.php.

$styles

PhpOffice\PhpSpreadsheet\Reader\Xml::$styles = []

protected

Definition at line 33 of file Xml.php.

---

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

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