Inheritance diagram for PhpOffice\PhpSpreadsheet\Reader\Ods:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Reader\Ods:

Public Member Functions
	__construct ()
	Create a new Ods 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 PhpSpreadsheet object. More...

	listWorksheetInfo ($pFilename)
	Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). More...

	load ($pFilename)
	Loads PhpSpreadsheet 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...

Private Member Functions
	processSettings (ZipArchive $zip, Spreadsheet $spreadsheet)

	setSelected (Spreadsheet $spreadsheet, string $wsname, string $setCol, string $setRow)

	parseRichText ($is)

	convertToExcelFormulaValue (string $openOfficeFormula)

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 29 of file Ods.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Reader\Ods::__construct ( )

Create a new Ods Reader instance.

Reimplemented from PhpOffice\PhpSpreadsheet\Reader\BaseReader.

Definition at line 34 of file Ods.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\Ods::canRead ( $pFilename )

Can the current IReader read the file?

Parameters

string $pFilename

Returns: bool

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 47 of file Ods.php.

    {
        File::assertFile($pFilename);
 
        $mimeType = 'UNKNOWN';
 
        // Load file
 
        $zip = new ZipArchive();
        if ($zip->open($pFilename) === true) {
            // check if it is an OOXML archive
            $stat = $zip->statName('mimetype');
            if ($stat && ($stat['size'] <= 255)) {
                $mimeType = $zip->getFromName($stat['name']);
            } elseif ($zip->statName('META-INF/manifest.xml')) {
                $xml = simplexml_load_string(
                    $this->securityScanner->scan($zip->getFromName('META-INF/manifest.xml')),
                    'SimpleXMLElement',
                    Settings::getLibXmlLoaderOptions()
                );
                $namespacesContent = $xml->getNamespaces(true);
                if (isset($namespacesContent['manifest'])) {
                    $manifest = $xml->children($namespacesContent['manifest']);
                    foreach ($manifest as $manifestDataSet) {
                        $manifestAttributes = $manifestDataSet->attributes($namespacesContent['manifest']);
                        if ($manifestAttributes->{'full-path'} == '/') {
                            $mimeType = (string) $manifestAttributes->{'media-type'};
 
                            break;
                        }
                    }
                }
            }
 
            $zip->close();
        }
 
        return $mimeType === 'application/vnd.oasis.opendocument.spreadsheet';
    }

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

Here is the call graph for this function:

◆ convertToExcelFormulaValue()

PhpOffice\PhpSpreadsheet\Reader\Ods::convertToExcelFormulaValue ( string $openOfficeFormula )

private

Definition at line 771 of file Ods.php.

                                                                          : string
    {
        $temp = explode('"', $openOfficeFormula);
        $tKey = false;
        foreach ($temp as &$value) {
            // Only replace in alternate array entries (i.e. non-quoted blocks)
            if ($tKey = !$tKey) {
                // Cell range reference in another sheet
                $value = preg_replace('/\[\$?([^\.]+)\.([^\.]+):\.([^\.]+)\]/miu', '$1!$2:$3', $value);
                // Cell reference in another sheet
                $value = preg_replace('/\[\$?([^\.]+)\.([^\.]+)\]/miu', '$1!$2', $value ?? '');
                // Cell range reference
                $value = preg_replace('/\[\.([^\.]+):\.([^\.]+)\]/miu', '$1:$2', $value ?? '');
                // Simple cell reference
                $value = preg_replace('/\[\.([^\.]+)\]/miu', '$1', $value ?? '');
                // Convert references to defined names/formulae
                $value = str_replace('$$', '', $value ?? '');
 
                $value = Calculation::translateSeparator(';', ',', $value, $inBraces);
            }
        }
 
        // Then rebuild the formula string
        $excelFormula = implode('"', $temp);
 
        return $excelFormula;
    }

◆ listWorksheetInfo()

PhpOffice\PhpSpreadsheet\Reader\Ods::listWorksheetInfo ( $pFilename )

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

Parameters

string $pFilename

Returns: array

Definition at line 146 of file Ods.php.

    {
        File::assertFile($pFilename);
 
        $worksheetInfo = [];
 
        $zip = new ZipArchive();
        if ($zip->open($pFilename) !== true) {
            throw new ReaderException('Could not open ' . $pFilename . ' for reading! Error opening file.');
        }
 
        $xml = new XMLReader();
        $xml->xml(
            $this->securityScanner->scanFile('zip://' . realpath($pFilename) . '#content.xml'),
            null,
            Settings::getLibXmlLoaderOptions()
        );
        $xml->setParserProperty(2, true);
 
        // Step into the first level of content of the XML
        $xml->read();
        while ($xml->read()) {
            // Quickly jump through to the office:body node
            while ($xml->name !== 'office:body') {
                if ($xml->isEmptyElement) {
                    $xml->read();
                } else {
                    $xml->next();
                }
            }
            // Now read each node until we find our first table:table node
            while ($xml->read()) {
                if ($xml->name == 'table:table' && $xml->nodeType == XMLReader::ELEMENT) {
                    $worksheetNames[] = $xml->getAttribute('table:name');
 
                    $tmpInfo = [
                        'worksheetName' => $xml->getAttribute('table:name'),
                        'lastColumnLetter' => 'A',
                        'lastColumnIndex' => 0,
                        'totalRows' => 0,
                        'totalColumns' => 0,
                    ];
 
                    // Loop through each child node of the table:table element reading
                    $currCells = 0;
                    do {
                        $xml->read();
                        if ($xml->name == 'table:table-row' && $xml->nodeType == XMLReader::ELEMENT) {
                            $rowspan = $xml->getAttribute('table:number-rows-repeated');
                            $rowspan = empty($rowspan) ? 1 : $rowspan;
                            $tmpInfo['totalRows'] += $rowspan;
                            $tmpInfo['totalColumns'] = max($tmpInfo['totalColumns'], $currCells);
                            $currCells = 0;
                            // Step into the row
                            $xml->read();
                            do {
                                $doread = true;
                                if ($xml->name == 'table:table-cell' && $xml->nodeType == XMLReader::ELEMENT) {
                                    if (!$xml->isEmptyElement) {
                                        ++$currCells;
                                        $xml->next();
                                        $doread = false;
                                    }
                                } elseif ($xml->name == 'table:covered-table-cell' && $xml->nodeType == XMLReader::ELEMENT) {
                                    $mergeSize = $xml->getAttribute('table:number-columns-repeated');
                                    $currCells += (int) $mergeSize;
                                }
                                if ($doread) {
                                    $xml->read();
                                }
                            } while ($xml->name != 'table:table-row');
                        }
                    } while ($xml->name != 'table:table');
 
                    $tmpInfo['totalColumns'] = max($tmpInfo['totalColumns'], $currCells);
                    $tmpInfo['lastColumnIndex'] = $tmpInfo['totalColumns'] - 1;
                    $tmpInfo['lastColumnLetter'] = Coordinate::stringFromColumnIndex($tmpInfo['lastColumnIndex'] + 1);
                    $worksheetInfo[] = $tmpInfo;
                }
            }
        }
 
        return $worksheetInfo;
    }

References $xml.

◆ listWorksheetNames()

PhpOffice\PhpSpreadsheet\Reader\Ods::listWorksheetNames ( $pFilename )

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

Parameters

string $pFilename

Returns: string[]

Definition at line 94 of file Ods.php.

    {
        File::assertFile($pFilename);
 
        $zip = new ZipArchive();
        if ($zip->open($pFilename) !== true) {
            throw new ReaderException('Could not open ' . $pFilename . ' for reading! Error opening file.');
        }
 
        $worksheetNames = [];
 
        $xml = new XMLReader();
        $xml->xml(
            $this->securityScanner->scanFile('zip://' . realpath($pFilename) . '#content.xml'),
            null,
            Settings::getLibXmlLoaderOptions()
        );
        $xml->setParserProperty(2, true);
 
        // Step into the first level of content of the XML
        $xml->read();
        while ($xml->read()) {
            // Quickly jump through to the office:body node
            while ($xml->name !== 'office:body') {
                if ($xml->isEmptyElement) {
                    $xml->read();
                } else {
                    $xml->next();
                }
            }
            // Now read each node until we find our first table:table node
            while ($xml->read()) {
                if ($xml->name == 'table:table' && $xml->nodeType == XMLReader::ELEMENT) {
                    // Loop through each table:table node reading the table:name attribute for each worksheet name
                    do {
                        $worksheetNames[] = $xml->getAttribute('table:name');
                        $xml->next();
                    } while ($xml->name == 'table:table' && $xml->nodeType == XMLReader::ELEMENT);
                }
            }
        }
 
        return $worksheetNames;
    }

References $xml.

◆ load()

PhpOffice\PhpSpreadsheet\Reader\Ods::load ( $pFilename )

Loads PhpSpreadsheet from file.

Parameters

string $pFilename

Returns: Spreadsheet

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 238 of file Ods.php.

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

◆ parseRichText()

PhpOffice\PhpSpreadsheet\Reader\Ods::parseRichText ( $is )

private

Parameters

string $is

Returns: RichText

Definition at line 763 of file Ods.php.

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

◆ processSettings()

PhpOffice\PhpSpreadsheet\Reader\Ods::processSettings	(	ZipArchive	$zip,
		Spreadsheet	$spreadsheet
	)

private

Definition at line 654 of file Ods.php.

                                                                               : void
    {
        $dom = new DOMDocument('1.01', 'UTF-8');
        $dom->loadXML(
            $this->securityScanner->scan($zip->getFromName('settings.xml')),
            Settings::getLibXmlLoaderOptions()
        );
        //$xlinkNs = $dom->lookupNamespaceUri('xlink');
        $configNs = $dom->lookupNamespaceUri('config');
        //$oooNs = $dom->lookupNamespaceUri('ooo');
        $officeNs = $dom->lookupNamespaceUri('office');
        $settings = $dom->getElementsByTagNameNS($officeNs, 'settings')
            ->item(0);
        $this->lookForActiveSheet($settings, $spreadsheet, $configNs);
        $this->lookForSelectedCells($settings, $spreadsheet, $configNs);
    }

◆ setSelected()

PhpOffice\PhpSpreadsheet\Reader\Ods::setSelected	(	Spreadsheet	$spreadsheet,
		string	$wsname,
		string	$setCol,
		string	$setRow
	)

private

Definition at line 712 of file Ods.php.

                                                                                                          : void
    {
        if (is_numeric($setCol) && is_numeric($setRow)) {
            try {
                $spreadsheet->getSheetByName($wsname)->setSelectedCellByColumnAndRow($setCol + 1, $setRow + 1);
            } catch (Throwable $e) {
                // do nothing
            }
        }
    }

References PhpOffice\PhpSpreadsheet\Spreadsheet\getSheetByName().

Here is the call graph for this function:

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Reader/Ods.php

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canRead()

◆ convertToExcelFormulaValue()

◆ listWorksheetInfo()

◆ listWorksheetNames()

◆ load()

◆ parseRichText()

◆ processSettings()

◆ setSelected()