Properties

$readDataOnly

$readDataOnly : boolean

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.

Type

boolean

$readEmptyCells

$readEmptyCells : boolean

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.

Type

boolean

$includeCharts

$includeCharts : boolean

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

Type

boolean

$loadSheetsOnly

$loadSheetsOnly : array

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.

Type

array — of string

$fileHandle

$fileHandle : 

Type

$styles

$styles : array

Formats.

Type

array

$charSet

$charSet : string

Character set used in the file.

Type

string

Methods

__construct()

__construct() 

Create a new Excel2003XML Reader instance.

getReadDataOnly()

getReadDataOnly() : boolean

Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting information.

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

Returns

boolean

setReadDataOnly()

setReadDataOnly(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Reader\IReader

Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.

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

Parameters

boolean $pValue

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader

getReadEmptyCells()

getReadEmptyCells() : boolean

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

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

Returns

boolean

setReadEmptyCells()

setReadEmptyCells(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Reader\IReader

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

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

Parameters

boolean $pValue

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader

getIncludeCharts()

getIncludeCharts() : boolean

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

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.

Returns

boolean

setIncludeCharts()

setIncludeCharts(boolean  $pValue) : \PhpOffice\PhpSpreadsheet\Reader\IReader

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

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

boolean $pValue

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader

getLoadSheetsOnly()

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.

Returns

mixed

setLoadSheetsOnly()

setLoadSheetsOnly(mixed  $value) : \PhpOffice\PhpSpreadsheet\Reader\IReader

Set which sheets to load.

Parameters

mixed $value

This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name. If NULL, then it tells the Reader to read all worksheets in the workbook

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader

setLoadAllSheets()

setLoadAllSheets() : \PhpOffice\PhpSpreadsheet\Reader\IReader

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

Returns

\PhpOffice\PhpSpreadsheet\Reader\IReader

getSecurityScanner()

getSecurityScanner() 

canRead()

canRead(string  $pFilename) : boolean

Can the current IReader read the file?

Parameters

string $pFilename

Returns

boolean

trySimpleXMLLoadString()

trySimpleXMLLoadString(string  $pFilename) : false|\SimpleXMLElement

Check if the file is a valid SimpleXML.

Parameters

string $pFilename

Returns

false|\SimpleXMLElement

listWorksheetNames()

listWorksheetNames(string  $pFilename) : array

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

Parameters

string $pFilename

Returns

array

listWorksheetInfo()

listWorksheetInfo(string  $pFilename) : array

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

Parameters

string $pFilename

Returns

array

load()

load(string  $pFilename) : \PhpOffice\PhpSpreadsheet\Spreadsheet

Loads Spreadsheet from file.

Parameters

string $pFilename

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet

loadIntoExisting()

loadIntoExisting(string  $pFilename, \PhpOffice\PhpSpreadsheet\Spreadsheet  $spreadsheet) : \PhpOffice\PhpSpreadsheet\Spreadsheet

Loads from file into Spreadsheet instance.

Parameters

string $pFilename
\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet

Returns

\PhpOffice\PhpSpreadsheet\Spreadsheet

openFile()

openFile(string  $pFilename) 

Open file for reading.

Parameters

string $pFilename

pixel2WidthUnits()

pixel2WidthUnits(float  $pxs) : float

pixel units to excel width units(units of 1/256th of a character width).

Parameters

float $pxs

Returns

float

widthUnits2Pixel()

widthUnits2Pixel(float  $widthUnits) : float

excel width units(units of 1/256th of a character width) to pixel units.

Parameters

float $widthUnits

Returns

float

hex2str()

hex2str(  $hex) 

Parameters

$hex

convertStringEncoding()

convertStringEncoding(  $string,   $charset) 

Parameters

$string
$charset

parseRichText()

parseRichText(  $is) 

Parameters

$is

identifyFixedStyleValue()

identifyFixedStyleValue(  $styleList,   $styleAttributeValue) 

Parameters

$styleList
$styleAttributeValue

parseStyles()

parseStyles(\SimpleXMLElement  $xml, array  $namespaces) 

Parameters

\SimpleXMLElement $xml
array $namespaces

parseStyleAlignment()

parseStyleAlignment(string  $styleID, \SimpleXMLElement  $styleAttributes) 

Parameters

string $styleID
\SimpleXMLElement $styleAttributes

parseStyleBorders()

parseStyleBorders(  $styleID, \SimpleXMLElement  $styleData, array  $namespaces) 

Parameters

$styleID
\SimpleXMLElement $styleData
array $namespaces

parseStyleFont()

parseStyleFont(  $styleID, \SimpleXMLElement  $styleAttributes) 

Parameters

$styleID
\SimpleXMLElement $styleAttributes

parseStyleInterior()

parseStyleInterior(  $styleID, \SimpleXMLElement  $styleAttributes) 

Parameters

$styleID
\SimpleXMLElement $styleAttributes

parseStyleNumberFormat()

parseStyleNumberFormat(  $styleID, \SimpleXMLElement  $styleAttributes) 

Parameters

$styleID
\SimpleXMLElement $styleAttributes