Documentation

Xlsx extends BaseReader
in package

Table of Contents

Constants

INITIAL_FILE  = '_rels/.rels'
REL_TO_CHART  = [\PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_RELATIONSHIPS => \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_CHART]
REL_TO_DRAWING  = [\PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_RELATIONSHIPS => \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_DRAWING]
REL_TO_MAIN  = [\PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_OFFICE_DOCUMENT => \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_MAIN, \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::THUMBNAIL => '']

Properties

$fileHandle  : resource
$ignoreRowsWithNoCells  : bool
Ignore rows with no cells? Identifies whether the Reader should ignore rows with no cells.
$includeCharts  : bool
Read charts that are defined in the workbook? Identifies whether the Reader should read the definitions for any charts that exist in the workbook;.
$loadSheetsOnly  : null|array<string|int, string>
Restrict which sheets should be loaded? This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.
$readDataOnly  : bool
Read data only? Identifies whether the Reader should only read data values for cells, and ignore any formatting information; or whether it should read both data and formatting.
$readEmptyCells  : bool
Read empty cells? Identifies whether the Reader should read data values for all cells, or should ignore cells containing null value or empty string.
$readFilter  : IReadFilter
IReadFilter instance.
$securityScanner  : XmlScanner|null
$valueBinder  : IValueBinder|null
$referenceHelper  : ReferenceHelper
ReferenceHelper instance.
$sharedFormulae  : array<string|int, SharedFormula>
$styleReader  : Styles
$zip  : ZipArchive

Methods

__construct()  : mixed
Create a new Xlsx Reader instance.
canRead()  : bool
Can the current IReader read the file?
falseToArray()  : array<string|int, mixed>
getAttributes()  : SimpleXMLElement
getIgnoreRowsWithNoCells()  : bool
getIncludeCharts()  : bool
Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook.
getLoadSheetsOnly()  : null|array<string|int, string>
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.
getReadDataOnly()  : bool
Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting or structural information (like merges).
getReadEmptyCells()  : bool
Read empty cells? If this is true (the default), then the Reader will read data values for all cells, irrespective of value.
getReadFilter()  : IReadFilter
Read filter.
getSecurityScanner()  : XmlScanner|null
getSecurityScannerOrThrow()  : XmlScanner
getValueBinder()  : IValueBinder|null
listWorksheetInfo()  : array<int, array{worksheetName: string, lastColumnLetter: string, lastColumnIndex: int, totalRows: int, totalColumns: int, sheetState: string}>
Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
listWorksheetNames()  : array<string|int, string>
Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object.
load()  : Spreadsheet
Loads Spreadsheet from file.
replacePrefixes()  : string
setIgnoreRowsWithNoCells()  : self
setIncludeCharts()  : $this
Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook.
setLoadAllSheets()  : $this
Set all sheets to load Tells the Reader to load all worksheets from the workbook.
setLoadSheetsOnly()  : $this
Set which sheets to load.
setReadDataOnly()  : $this
Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting or structural information (like merges).
setReadEmptyCells()  : $this
Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value.
setReadFilter()  : $this
Set read filter.
setValueBinder()  : self
stripWhiteSpaceFromStyleString()  : string
testSimpleXml()  : SimpleXMLElement
loadSpreadsheetFromFile()  : Spreadsheet
Loads Spreadsheet from file.
newSpreadsheet()  : Spreadsheet
openFile()  : void
Open file for reading.
processFlags()  : void
boolean()  : bool
castToBoolean()  : bool
castToError()  : string|null
castToFormula()  : void
castToString()  : string|null
dirAdd()  : string
extractPalette()  : array<string|int, string>
extractStyles()  : array<string|int, mixed>
fileExistsInArchive()  : bool
getArrayItem()  : mixed
getArrayItemIntOrSxml()  : int|SimpleXMLElement
getArrayItemString()  : string
getFromZipArchive()  : string
getLockValue()  : bool|null
getWorkbookBaseName()  : array{: string, : string}
loadZip()  : SimpleXMLElement
loadZipNonamespace()  : SimpleXMLElement
onlyNoteVml()  : bool
parseRichText()  : RichText
processIgnoredErrors()  : void
readAutoFilter()  : void
readBackgroundImage()  : void
readFormControlProperties()  : void
readHyperLinkDrawing()  : void
readPrinterSettings()  : void
readProtection()  : void
readRibbon()  : void
readSheetProtection()  : void
readTables()  : void
readTablesInTablesFile()  : void
storeFormulaAttributes()  : void
toCSSArray()  : array<string|int, mixed>
xpathNoFalse()  : array<string|int, mixed>

Constants

INITIAL_FILE

public mixed INITIAL_FILE = '_rels/.rels'

REL_TO_CHART

private mixed REL_TO_CHART = [\PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_RELATIONSHIPS => \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_CHART]

REL_TO_DRAWING

private mixed REL_TO_DRAWING = [\PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_RELATIONSHIPS => \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_DRAWING]

REL_TO_MAIN

private mixed REL_TO_MAIN = [\PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_OFFICE_DOCUMENT => \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::PURL_MAIN, \PhpOffice\PhpSpreadsheet\Reader\Xlsx\Namespaces::THUMBNAIL => '']

Properties

$ignoreRowsWithNoCells

Ignore rows with no cells? Identifies whether the Reader should ignore rows with no cells.

protected bool $ignoreRowsWithNoCells = false

Currently implemented only for Xlsx.

$includeCharts

Read charts that are defined in the workbook? Identifies whether the Reader should read the definitions for any charts that exist in the workbook;.

protected bool $includeCharts = false

$loadSheetsOnly

Restrict which sheets should be loaded? This property holds an array of worksheet names to be loaded. If null, then all worksheets will be loaded.

protected null|array<string|int, string> $loadSheetsOnly = null

This property is ignored for Csv, Html, and Slk.

$readDataOnly

Read data only? Identifies whether the Reader should only read data values for cells, and ignore any formatting information; or whether it should read both data and formatting.

protected bool $readDataOnly = false

$readEmptyCells

Read empty cells? Identifies whether the Reader should read data values for all cells, or should ignore cells containing null value or empty string.

protected bool $readEmptyCells = true

$zip

private ZipArchive $zip

Methods

__construct()

Create a new Xlsx Reader instance.

public __construct() : mixed

canRead()

Can the current IReader read the file?

public canRead(string $filename) : bool
Parameters
$filename : string
Return values
bool

falseToArray()

public static falseToArray(mixed $value) : array<string|int, mixed>
Parameters
$value : mixed
Return values
array<string|int, mixed>

getAttributes()

public static getAttributes(SimpleXMLElement|null $value[, string $ns = '' ]) : SimpleXMLElement
Parameters
$value : SimpleXMLElement|null
$ns : string = ''
Return values
SimpleXMLElement

getIgnoreRowsWithNoCells()

public getIgnoreRowsWithNoCells() : bool
Return values
bool

getIncludeCharts()

Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook.

public getIncludeCharts() : bool

Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value. If false (the default) it will ignore any charts defined in the workbook file.

Return values
bool

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.

public getLoadSheetsOnly() : null|array<string|int, string>
Return values
null|array<string|int, string>

getReadDataOnly()

Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting or structural information (like merges).

public getReadDataOnly() : bool

If false (the default) it will read data and formatting.

Return values
bool

getReadEmptyCells()

Read empty cells? If this is true (the default), then the Reader will read data values for all cells, irrespective of value.

public getReadEmptyCells() : bool

If false it will not read data for cells containing a null value or an empty string.

Return values
bool

listWorksheetInfo()

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

public listWorksheetInfo(string $filename) : array<int, array{worksheetName: string, lastColumnLetter: string, lastColumnIndex: int, totalRows: int, totalColumns: int, sheetState: string}>
Parameters
$filename : string
Return values
array<int, array{worksheetName: string, lastColumnLetter: string, lastColumnIndex: int, totalRows: int, totalColumns: int, sheetState: string}>

listWorksheetNames()

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

public listWorksheetNames(string $filename) : array<string|int, string>
Parameters
$filename : string
Return values
array<string|int, string>

load()

Loads Spreadsheet from file.

public load(string $filename[, int $flags = 0 ]) : Spreadsheet
Parameters
$filename : string

The name of the file to load

$flags : int = 0

the optional second parameter flags may be used to identify specific elements that should be loaded, but which won't be loaded by default, using these values: IReader::LOAD_WITH_CHARTS - Include any charts that are defined in the loaded file

Return values
Spreadsheet

replacePrefixes()

public static replacePrefixes(string $formula) : string
Parameters
$formula : string
Return values
string

setIgnoreRowsWithNoCells()

public setIgnoreRowsWithNoCells(bool $ignoreRowsWithNoCells) : self
Parameters
$ignoreRowsWithNoCells : bool
Return values
self

setIncludeCharts()

Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook.

public setIncludeCharts(bool $includeCharts) : $this

Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value. Set to false (the default) to discard charts.

Parameters
$includeCharts : bool
Return values
$this

setLoadAllSheets()

Set all sheets to load Tells the Reader to load all worksheets from the workbook.

public setLoadAllSheets() : $this
Return values
$this

setLoadSheetsOnly()

Set which sheets to load.

public setLoadSheetsOnly(null|string|array<string|int, string> $sheetList) : $this
Parameters
$sheetList : null|string|array<string|int, string>
Return values
$this

setReadDataOnly()

Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting or structural information (like merges).

public setReadDataOnly(bool $readCellValuesOnly) : $this

Set to false (the default) to advise the Reader to read both data and formatting for cells.

Parameters
$readCellValuesOnly : bool
Return values
$this

setReadEmptyCells()

Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value.

public setReadEmptyCells(bool $readEmptyCells) : $this

Set to false to advise the Reader to ignore cells containing a null value or an empty string.

Parameters
$readEmptyCells : bool
Return values
$this

stripWhiteSpaceFromStyleString()

public static stripWhiteSpaceFromStyleString(string $string) : string
Parameters
$string : string
Return values
string

testSimpleXml()

public static testSimpleXml(mixed $value) : SimpleXMLElement
Parameters
$value : mixed
Return values
SimpleXMLElement

loadSpreadsheetFromFile()

Loads Spreadsheet from file.

protected loadSpreadsheetFromFile(string $filename) : Spreadsheet
Parameters
$filename : string
Return values
Spreadsheet

openFile()

Open file for reading.

protected openFile(string $filename) : void
Parameters
$filename : string

processFlags()

protected processFlags(int $flags) : void
Parameters
$flags : int

boolean()

private static boolean(string $value) : bool
Parameters
$value : string
Return values
bool

castToBoolean()

private static castToBoolean(SimpleXMLElement $c) : bool
Parameters
$c : SimpleXMLElement
Return values
bool

castToError()

private static castToError(SimpleXMLElement|null $c) : string|null
Parameters
$c : SimpleXMLElement|null
Return values
string|null

castToFormula()

private castToFormula(SimpleXMLElement|null $c, string $r, string &$cellDataType, mixed &$value, mixed &$calculatedValue, string $castBaseType[, bool $updateSharedCells = true ]) : void
Parameters
$c : SimpleXMLElement|null
$r : string
$cellDataType : string
$value : mixed
$calculatedValue : mixed
$castBaseType : string
$updateSharedCells : bool = true

castToString()

private static castToString(SimpleXMLElement|null $c) : string|null
Parameters
$c : SimpleXMLElement|null
Return values
string|null

dirAdd()

private static dirAdd(null|SimpleXMLElement|string $base, null|SimpleXMLElement|string $add) : string
Parameters
$base : null|SimpleXMLElement|string
$add : null|SimpleXMLElement|string
Return values
string

extractPalette()

private static extractPalette(SimpleXMLElement|null $sxml) : array<string|int, string>
Parameters
$sxml : SimpleXMLElement|null
Return values
array<string|int, string>

extractStyles()

private static extractStyles(SimpleXMLElement|null $sxml, string $node1, string $node2) : array<string|int, mixed>
Parameters
$sxml : SimpleXMLElement|null
$node1 : string
$node2 : string
Return values
array<string|int, mixed>

fileExistsInArchive()

private fileExistsInArchive(ZipArchive $archive[, string $fileName = '' ]) : bool
Parameters
$archive : ZipArchive
$fileName : string = ''
Return values
bool

getArrayItem()

private static getArrayItem(null|bool|array<string|int, mixed>|SimpleXMLElement $array[, int|string $key = 0 ]) : mixed
Parameters
$array : null|bool|array<string|int, mixed>|SimpleXMLElement
$key : int|string = 0

getArrayItemIntOrSxml()

private static getArrayItemIntOrSxml(null|bool|array<string|int, mixed>|SimpleXMLElement $array[, int|string $key = 0 ]) : int|SimpleXMLElement
Parameters
$array : null|bool|array<string|int, mixed>|SimpleXMLElement
$key : int|string = 0
Return values
int|SimpleXMLElement

getArrayItemString()

private static getArrayItemString(null|bool|array<string|int, mixed>|SimpleXMLElement $array[, int|string $key = 0 ]) : string
Parameters
$array : null|bool|array<string|int, mixed>|SimpleXMLElement
$key : int|string = 0
Return values
string

getFromZipArchive()

private getFromZipArchive(ZipArchive $archive[, string $fileName = '' ]) : string
Parameters
$archive : ZipArchive
$fileName : string = ''
Return values
string

getLockValue()

private static getLockValue(SimpleXMLElement $protection, string $key) : bool|null
Parameters
$protection : SimpleXMLElement
$key : string
Return values
bool|null

getWorkbookBaseName()

private getWorkbookBaseName() : array{: string, : string}
Return values
array{: string, : string}

loadZip()

private loadZip(string $filename[, string $ns = '' ][, bool $replaceUnclosedBr = false ]) : SimpleXMLElement
Parameters
$filename : string
$ns : string = ''
$replaceUnclosedBr : bool = false
Return values
SimpleXMLElement

loadZipNonamespace()

private loadZipNonamespace(string $filename, string $ns) : SimpleXMLElement
Parameters
$filename : string
$ns : string
Return values
SimpleXMLElement

onlyNoteVml()

private static onlyNoteVml(string $data) : bool
Parameters
$data : string
Return values
bool

parseRichText()

private parseRichText(SimpleXMLElement|null $is) : RichText
Parameters
$is : SimpleXMLElement|null
Return values
RichText

processIgnoredErrors()

private processIgnoredErrors(SimpleXMLElement $xml, Worksheet $sheet) : void
Parameters
$xml : SimpleXMLElement
$sheet : Worksheet

readAutoFilter()

private readAutoFilter(SimpleXMLElement $xmlSheet, Worksheet $docSheet) : void
Parameters
$xmlSheet : SimpleXMLElement
$docSheet : Worksheet

readBackgroundImage()

private readBackgroundImage(SimpleXMLElement $xmlSheet, Worksheet $docSheet, string $relsName) : void
Parameters
$xmlSheet : SimpleXMLElement
$docSheet : Worksheet
$relsName : string

readFormControlProperties()

private readFormControlProperties(Spreadsheet $excel, string $dir, string $fileWorksheet, Worksheet $docSheet, array<string|int, array<string|int, array<string|int, array<string|int, mixed>>>> &$unparsedLoadedData) : void
Parameters
$excel : Spreadsheet
$dir : string
$fileWorksheet : string
$docSheet : Worksheet
$unparsedLoadedData : array<string|int, array<string|int, array<string|int, array<string|int, mixed>>>>

readHyperLinkDrawing()

private readHyperLinkDrawing(Drawing $objDrawing, SimpleXMLElement $cellAnchor, array<string|int, string> $hyperlinks) : void
Parameters
$objDrawing : Drawing
$cellAnchor : SimpleXMLElement
$hyperlinks : array<string|int, string>

readPrinterSettings()

private readPrinterSettings(Spreadsheet $excel, string $dir, string $fileWorksheet, Worksheet $docSheet, array<string|int, array<string|int, array<string|int, array<string|int, mixed>>>> &$unparsedLoadedData) : void
Parameters
$excel : Spreadsheet
$dir : string
$fileWorksheet : string
$docSheet : Worksheet
$unparsedLoadedData : array<string|int, array<string|int, array<string|int, array<string|int, mixed>>>>

readProtection()

private readProtection(Spreadsheet $excel, SimpleXMLElement $xmlWorkbook) : void
Parameters
$excel : Spreadsheet
$xmlWorkbook : SimpleXMLElement

readRibbon()

private readRibbon(Spreadsheet $excel, string $customUITarget, ZipArchive $zip) : void
Parameters
$excel : Spreadsheet
$customUITarget : string
$zip : ZipArchive

readSheetProtection()

private readSheetProtection(Worksheet $docSheet, SimpleXMLElement $xmlSheet) : void
Parameters
$docSheet : Worksheet
$xmlSheet : SimpleXMLElement

readTables()

private readTables(SimpleXMLElement $xmlSheet, Worksheet $docSheet, string $dir, string $fileWorksheet, ZipArchive $zip, string $namespaceTable, array<string|int, TableDxfsStyle> $tableStyles, array<string|int, Style> $dxfs) : void
Parameters
$xmlSheet : SimpleXMLElement
$docSheet : Worksheet
$dir : string
$fileWorksheet : string
$zip : ZipArchive
$namespaceTable : string
$tableStyles : array<string|int, TableDxfsStyle>
$dxfs : array<string|int, Style>

readTablesInTablesFile()

private readTablesInTablesFile(SimpleXMLElement $xmlSheet, string $dir, string $fileWorksheet, ZipArchive $zip, Worksheet $docSheet, string $namespaceTable, array<string|int, TableDxfsStyle> $tableStyles, array<string|int, Style> $dxfs) : void
Parameters
$xmlSheet : SimpleXMLElement
$dir : string
$fileWorksheet : string
$zip : ZipArchive
$docSheet : Worksheet
$namespaceTable : string
$tableStyles : array<string|int, TableDxfsStyle>
$dxfs : array<string|int, Style>

storeFormulaAttributes()

private static storeFormulaAttributes(SimpleXMLElement $f, Worksheet $docSheet, string $r) : void
Parameters
$f : SimpleXMLElement
$docSheet : Worksheet
$r : string

toCSSArray()

private static toCSSArray(string $style) : array<string|int, mixed>
Parameters
$style : string
Return values
array<string|int, mixed>

xpathNoFalse()

private static xpathNoFalse(SimpleXMLElement $sxml, string $path) : array<string|int, mixed>
Parameters
$sxml : SimpleXMLElement
$path : string
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results