Documentation

IReader
in

Table of Contents

Constants

IGNORE_EMPTY_CELLS  = 4
Flag used to ignore empty cells when reading.
IGNORE_ROWS_WITH_NO_CELLS  = 8
Flag used to ignore rows without cells.
LOAD_WITH_CHARTS  = 1
Flag used to load the charts.
READ_DATA_ONLY  = 2
Flag used to read data only, not style or structure information.
SKIP_EMPTY_CELLS  = self::IGNORE_EMPTY_CELLS

Methods

__construct()  : mixed
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()  : array<string|int, mixed>|null
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.
load()  : Spreadsheet
Loads PhpSpreadsheet from file.
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.

Constants

IGNORE_EMPTY_CELLS

Flag used to ignore empty cells when reading.

public mixed IGNORE_EMPTY_CELLS = 4

The ignored cells will not be instantiated.

IGNORE_ROWS_WITH_NO_CELLS

Flag used to ignore rows without cells.

public mixed IGNORE_ROWS_WITH_NO_CELLS = 8

This flag is supported only for some formats. This can heavily improve performance for some files.

LOAD_WITH_CHARTS

Flag used to load the charts.

public mixed LOAD_WITH_CHARTS = 1

This flag is supported only for some formats.

READ_DATA_ONLY

Flag used to read data only, not style or structure information.

public mixed READ_DATA_ONLY = 2

SKIP_EMPTY_CELLS

public mixed SKIP_EMPTY_CELLS = self::IGNORE_EMPTY_CELLS
Tags
deprecated
3.4.0

use IGNORE_EMPTY_CELLS instead.

Methods

__construct()

public __construct() : 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() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

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

load()

Loads PhpSpreadsheet from file.

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

The name of the file to load

$flags : int = 0

Flags that can change the behaviour of the Writer: self::LOAD_WITH_CHARTS Load any charts that are defined (if the Reader supports Charts) self::READ_DATA_ONLY Read only data, not style or structure information, from the file self::IGNORE_EMPTY_CELLS Don't read empty cells (cells that contain a null value, empty string, or a string containing only whitespace characters)

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(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|array<string|int, mixed>|string $value) : $this
Parameters
$value : null|array<string|int, mixed>|string

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

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 $readDataOnly) : $this

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

Parameters
$readDataOnly : 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 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results