Documentation

Xlsx extends BaseReader

Table of Contents

INITIAL_FILE  = '_rels/.rels'
REL_TO_CHART  = [PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_RELATIONSHIPS => PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_CHART]
REL_TO_DRAWING  = [PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_RELATIONSHIPS => PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_DRAWING]
REL_TO_MAIN  = [PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_OFFICE_DOCUMENT => PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_MAIN, PhpOfficePhpSpreadsheetReaderXlsxNamespaces::THUMBNAIL => '']
$fileHandle  : resource
$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 cells all cells, or should ignore cells containing null value or empty string.
$readFilter  : IReadFilter
IReadFilter instance.
$securityScanner  : XmlScanner|null
$referenceHelper  : ReferenceHelper
ReferenceHelper instance.
$styleReader  : Styles
$zip  : ZipArchive
__construct()  : mixed
Create a new Xlsx Reader instance.
canRead()  : bool
Can the current IReader read the file?
falseToArray()  : array<string|int, mixed>
getAttributes()  : SimpleXMLElement
getIncludeCharts()  : bool
Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook.
getLoadSheetsOnly()  : mixed
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
listWorksheetInfo()  : array<string|int, mixed>
Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
listWorksheetNames()  : array<string|int, mixed>
Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object.
load()  : Spreadsheet
Loads Spreadsheet from file.
setIncludeCharts()  : IReader
Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook.
setLoadAllSheets()  : IReader
Set all sheets to load Tells the Reader to load all worksheets from the workbook.
setLoadSheetsOnly()  : IReader
Set which sheets to load.
setReadDataOnly()  : IReader
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()  : IReader
Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value.
setReadFilter()  : IReader
Set read filter.
stripWhiteSpaceFromStyleString()  : string
testSimpleXml()  : SimpleXMLElement
loadSpreadsheetFromFile()  : Spreadsheet
Loads Spreadsheet from file.
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, mixed>
extractStyles()  : array<string|int, mixed>
fileExistsInArchive()  : bool
getArrayItem()  : mixed
getFromZipArchive()  : string
getLockValue()  : bool|null
getWorkbookBaseName()  : array<string|int, mixed>
loadZip()  : SimpleXMLElement
loadZipNonamespace()  : SimpleXMLElement
parseRichText()  : RichText
readAutoFilter()  : void
readFormControlProperties()  : void
readHyperLinkDrawing()  : void
readPrinterSettings()  : void
readProtection()  : void
readRibbon()  : void
readSheetProtection()  : void
readTables()  : void
readTablesInTablesFile()  : 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 = [PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_RELATIONSHIPS => PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_CHART]

REL_TO_DRAWING

private mixed REL_TO_DRAWING = [PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_RELATIONSHIPS => PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_DRAWING]

REL_TO_MAIN

private mixed REL_TO_MAIN = [PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_OFFICE_DOCUMENT => PhpOfficePhpSpreadsheetReaderXlsxNamespaces::PURL_MAIN, PhpOfficePhpSpreadsheetReaderXlsxNamespaces::THUMBNAIL => '']

Properties

$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

$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 cells 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
Return values
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 —

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() : mixed
Return values
mixed —

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<string|int, mixed>
Parameters
$filename : string
Return values
array<string|int, mixed> —

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, mixed>
Parameters
$filename : string
Return values
array<string|int, mixed> —

load()

Loads Spreadsheet from file.

public load(string $filename, int $flags) : Spreadsheet
Parameters
$filename : string

The name of the file to load

$flags : int

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 —

setIncludeCharts()

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

public setIncludeCharts(mixed $includeCharts) : IReader

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 : mixed
Return values
IReader —

setLoadAllSheets()

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

public setLoadAllSheets() : IReader
Return values
IReader —

setLoadSheetsOnly()

Set which sheets to load.

public setLoadSheetsOnly(mixed $sheetList) : IReader
Parameters
$sheetList : mixed
Return values
IReader —

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(mixed $readCellValuesOnly) : IReader

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

Parameters
$readCellValuesOnly : mixed
Return values
IReader —

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(mixed $readEmptyCells) : IReader

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

Parameters
$readEmptyCells : mixed
Return values
IReader —

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
Return values
void —

processFlags()

protected processFlags(int $flags) : void
Parameters
$flags : int
Return values
void —

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, array<string|int, mixed> &$sharedFormulas, string $castBaseType) : void
Parameters
$c : SimpleXMLElement|null
$r : string
$cellDataType : string
$value : mixed
$calculatedValue : mixed
$sharedFormulas : array<string|int, mixed>
$castBaseType : string
Return values
void —

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, mixed>
Parameters
$sxml : SimpleXMLElement|null
Return values
array<string|int, mixed> —

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|array<string|int, mixed>|bool|SimpleXMLElement $array, int|string $key) : mixed
Parameters
$array : null|array<string|int, mixed>|bool|SimpleXMLElement
$key : int|string
Return values
mixed —

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|int, mixed>
Return values
array<string|int, mixed> —

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 —

parseRichText()

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

readAutoFilter()

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

readFormControlProperties()

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

readHyperLinkDrawing()

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

readPrinterSettings()

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

readProtection()

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

readRibbon()

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

readSheetProtection()

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

readTables()

private readTables(SimpleXMLElement $xmlSheet, Worksheet $docSheet, string $dir, string $fileWorksheet, ZipArchive $zip) : void
Parameters
$xmlSheet : SimpleXMLElement
$docSheet : Worksheet
$dir : string
$fileWorksheet : string
$zip : ZipArchive
Return values
void —

readTablesInTablesFile()

private readTablesInTablesFile(SimpleXMLElement $xmlSheet, string $dir, string $fileWorksheet, ZipArchive $zip, Worksheet $docSheet) : void
Parameters
$xmlSheet : SimpleXMLElement
$dir : string
$fileWorksheet : string
$zip : ZipArchive
$docSheet : Worksheet
Return values
void —

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> —

Search results