Documentation

Gnumeric extends BaseReader

Table of Contents

NAMESPACE_DC  = 'http://purl.org/dc/elements/1.1/'
NAMESPACE_GNM  = 'http://www.gnumeric.org/v10.dtd'
NAMESPACE_META  = 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0'
NAMESPACE_OFFICE  = 'urn:oasis:names:tc:opendocument:xmlns:office:1.0'
NAMESPACE_OOO  = 'http://openoffice.org/2004/office'
NAMESPACE_XLINK  = 'http://www.w3.org/1999/xlink'
NAMESPACE_XSI  = 'http://www.w3.org/2001/XMLSchema-instance'
$mappings  : array<string|int, mixed>
$fileHandle  : mixed
$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
$expressions  : array<string|int, mixed>
Shared Expressions.
$referenceHelper  : ReferenceHelper
$spreadsheet  : Spreadsheet
Spreadsheet shared across all functions.
__construct()  : mixed
Create a new Gnumeric.
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 information.
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()  : mixed
gnumericMappings()  : array<string|int, mixed>
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.
loadIntoExisting()  : Spreadsheet
Loads from file into Spreadsheet 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 information.
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 Spreadsheet from file.
openFile()  : void
Open file for reading.
processFlags()  : void
gzfileGetContents()  : string
loadCell()  : void
matchXml()  : bool
parseRichText()  : RichText
processAutofilter()  : void
processColumnLoop()  : int
processColumnWidths()  : void
processComments()  : void
processDefinedNames()  : void
processMergedCells()  : void
processRowHeights()  : void
processRowLoop()  : int
setColumnInvisible()  : void
setColumnWidth()  : void
setRowHeight()  : void
setRowInvisible()  : void
setSelectedCells()  : void
setSelectedSheet()  : void
testSimpleXml()  : SimpleXMLElement

Constants

NAMESPACE_DC

public mixed NAMESPACE_DC = 'http://purl.org/dc/elements/1.1/'

NAMESPACE_GNM

public mixed NAMESPACE_GNM = 'http://www.gnumeric.org/v10.dtd'

NAMESPACE_META

public mixed NAMESPACE_META = 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0'

NAMESPACE_OFFICE

public mixed NAMESPACE_OFFICE = 'urn:oasis:names:tc:opendocument:xmlns:office:1.0'

NAMESPACE_OOO

public mixed NAMESPACE_OOO = 'http://openoffice.org/2004/office'
public mixed NAMESPACE_XLINK = 'http://www.w3.org/1999/xlink'

NAMESPACE_XSI

public mixed NAMESPACE_XSI = 'http://www.w3.org/2001/XMLSchema-instance'

Properties

$mappings

public static array<string|int, mixed> $mappings = ['dataType' => [ '10' => PhpOfficePhpSpreadsheetCellDataType::TYPE_NULL, '20' => PhpOfficePhpSpreadsheetCellDataType::TYPE_BOOL, '30' => PhpOfficePhpSpreadsheetCellDataType::TYPE_NUMERIC, // Integer doesn't exist in Excel '40' => PhpOfficePhpSpreadsheetCellDataType::TYPE_NUMERIC, // Float '50' => PhpOfficePhpSpreadsheetCellDataType::TYPE_ERROR, '60' => PhpOfficePhpSpreadsheetCellDataType::TYPE_STRING, ]]

$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

$expressions

Shared Expressions.

private array<string|int, mixed> $expressions = []

Methods

__construct()

Create a new Gnumeric.

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 information.

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

getSecurityScanner()

public getSecurityScanner() : mixed
Return values
mixed

gnumericMappings()

public static gnumericMappings() : array<string|int, mixed>
Return values
array<string|int, mixed>

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
$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 information.

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

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

gzfileGetContents()

private gzfileGetContents(string $filename) : string
Parameters
$filename : string
Return values
string

loadCell()

private loadCell(SimpleXMLElement $cell, string $worksheetName, SimpleXMLElement $cellAttributes, string $column, int $row) : void
Parameters
$cell : SimpleXMLElement
$worksheetName : string
$cellAttributes : SimpleXMLElement
$column : string
$row : int
Return values
void

matchXml()

private static matchXml(XMLReader $xml, string $expectedLocalName) : bool
Parameters
$xml : XMLReader
$expectedLocalName : string
Return values
bool

processAutofilter()

private processAutofilter(SimpleXMLElement|null $sheet) : void
Parameters
$sheet : SimpleXMLElement|null
Return values
void

processColumnLoop()

private processColumnLoop(int $whichColumn, int $maxCol, SimpleXMLElement|null $columnOverride, float $defaultWidth) : int
Parameters
$whichColumn : int
$maxCol : int
$columnOverride : SimpleXMLElement|null
$defaultWidth : float
Return values
int

processColumnWidths()

private processColumnWidths(SimpleXMLElement|null $sheet, int $maxCol) : void
Parameters
$sheet : SimpleXMLElement|null
$maxCol : int
Return values
void

processComments()

private processComments(SimpleXMLElement $sheet) : void
Parameters
$sheet : SimpleXMLElement
Return values
void

processDefinedNames()

private processDefinedNames(SimpleXMLElement|null $gnmXML) : void
Parameters
$gnmXML : SimpleXMLElement|null
Return values
void

processMergedCells()

private processMergedCells(SimpleXMLElement|null $sheet) : void
Parameters
$sheet : SimpleXMLElement|null
Return values
void

processRowHeights()

private processRowHeights(SimpleXMLElement|null $sheet, int $maxRow) : void
Parameters
$sheet : SimpleXMLElement|null
$maxRow : int
Return values
void

processRowLoop()

private processRowLoop(int $whichRow, int $maxRow, SimpleXMLElement|null $rowOverride, float $defaultHeight) : int
Parameters
$whichRow : int
$maxRow : int
$rowOverride : SimpleXMLElement|null
$defaultHeight : float
Return values
int

setColumnInvisible()

private setColumnInvisible(int $whichColumn) : void
Parameters
$whichColumn : int
Return values
void

setColumnWidth()

private setColumnWidth(int $whichColumn, float $defaultWidth) : void
Parameters
$whichColumn : int
$defaultWidth : float
Return values
void

setRowHeight()

private setRowHeight(int $whichRow, float $defaultHeight) : void
Parameters
$whichRow : int
$defaultHeight : float
Return values
void

setRowInvisible()

private setRowInvisible(int $whichRow) : void
Parameters
$whichRow : int
Return values
void

setSelectedCells()

private setSelectedCells(SimpleXMLElement|null $sheet) : void
Parameters
$sheet : SimpleXMLElement|null
Return values
void

setSelectedSheet()

private setSelectedSheet(SimpleXMLElement $gnmXML) : void
Parameters
$gnmXML : SimpleXMLElement
Return values
void

testSimpleXml()

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

Search results