Ods extends BaseReader
Table of Contents
- INITIAL_FILE = 'content.xml'
- $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
- __construct() : mixed
- Create a new Ods Reader instance.
- canRead() : bool
- Can the current IReader read the file?
- 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, string>
- Reads names of the worksheets from a file, without parsing the whole file to a PhpSpreadsheet object.
- load() : Spreadsheet
- Loads Spreadsheet from file.
- loadIntoExisting() : Spreadsheet
- Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
- 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.
- loadSpreadsheetFromFile() : Spreadsheet
- Loads PhpSpreadsheet from file.
- openFile() : void
- Open file for reading.
- processFlags() : void
- scanElementForText() : string
- Recursively scan element.
- getMultiplier() : int
- getXmlName() : string
- Counteract Phpstan caching.
- lookForActiveSheet() : void
- lookForSelectedCells() : void
- parseRichText() : RichText
- processMergedCells() : void
- processSettings() : void
- setSelected() : void
Constants
INITIAL_FILE
public
mixed
INITIAL_FILE
= 'content.xml'
Properties
$fileHandle
protected
resource
$fileHandle
$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
$readFilter
IReadFilter instance.
protected
IReadFilter
$readFilter
$securityScanner
protected
XmlScanner|null
$securityScanner
Methods
__construct()
Create a new Ods 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 —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 —getReadFilter()
Read filter.
public
getReadFilter() : IReadFilter
Return values
IReadFilter —getSecurityScanner()
public
getSecurityScanner() : XmlScanner|null
Return values
XmlScanner|null —getSecurityScannerOrThrow()
public
getSecurityScannerOrThrow() : XmlScanner
Return values
XmlScanner —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 PhpSpreadsheet 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) : 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 —loadIntoExisting()
Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
public
loadIntoExisting(string $filename, Spreadsheet $spreadsheet) : Spreadsheet
Parameters
- $filename : string
- $spreadsheet : Spreadsheet
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 —setReadFilter()
Set read filter.
public
setReadFilter(IReadFilter $readFilter) : IReader
Parameters
- $readFilter : IReadFilter
Return values
IReader —loadSpreadsheetFromFile()
Loads PhpSpreadsheet 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 —scanElementForText()
Recursively scan element.
protected
scanElementForText(DOMNode $element) : string
Parameters
- $element : DOMNode
Return values
string —getMultiplier()
private
static getMultiplier(DOMAttr|null $cAttr) : int
Parameters
- $cAttr : DOMAttr|null
Return values
int —getXmlName()
Counteract Phpstan caching.
private
static getXmlName(XMLReader $xml) : string
Parameters
- $xml : XMLReader
Tags
Return values
string —lookForActiveSheet()
private
lookForActiveSheet(DOMElement $settings, Spreadsheet $spreadsheet, string $configNs) : void
Parameters
- $settings : DOMElement
- $spreadsheet : Spreadsheet
- $configNs : string
Return values
void —lookForSelectedCells()
private
lookForSelectedCells(DOMElement $settings, Spreadsheet $spreadsheet, string $configNs) : void
Parameters
- $settings : DOMElement
- $spreadsheet : Spreadsheet
- $configNs : string
Return values
void —parseRichText()
private
parseRichText(string $is) : RichText
Parameters
- $is : string
Return values
RichText —processMergedCells()
private
processMergedCells(DOMElement $cellData, string $tableNs, string $type, string $columnID, int $rowID, Spreadsheet $spreadsheet) : void
Parameters
- $cellData : DOMElement
- $tableNs : string
- $type : string
- $columnID : string
- $rowID : int
- $spreadsheet : Spreadsheet
Return values
void —processSettings()
private
processSettings(ZipArchive $zip, Spreadsheet $spreadsheet) : void
Parameters
- $zip : ZipArchive
- $spreadsheet : Spreadsheet
Return values
void —setSelected()
private
setSelected(Spreadsheet $spreadsheet, string $wsname, string $setCol, string $setRow) : void
Parameters
- $spreadsheet : Spreadsheet
- $wsname : string
- $setCol : string
- $setRow : string