Inheritance diagram for PhpOffice\PhpSpreadsheet\Reader\BaseReader:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Reader\BaseReader:

Public Member Functions
	__construct ()
	IReader constructor. More...

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

	setReadDataOnly ($pValue)
	Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information. More...

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

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

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

	setIncludeCharts ($pValue)
	Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook. More...

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

	setLoadSheetsOnly ($value)
	Set which sheets to load. More...

	setLoadAllSheets ()
	Set all sheets to load Tells the Reader to load all worksheets from the workbook. More...

	getReadFilter ()
	Read filter. More...

	setReadFilter (IReadFilter $pValue)
	Set read filter. More...

	getSecurityScanner ()

Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Reader\IReader
	canRead ($pFilename)
	Can the current IReader read the file? More...

	load ($pFilename)
	Loads PhpSpreadsheet from file. More...

Protected Member Functions
	openFile ($pFilename)
	Open file for reading. More...

Protected Attributes
	$readDataOnly = false

	$readEmptyCells = true

	$includeCharts = false

	$loadSheetsOnly

	$readFilter

	$fileHandle

	$securityScanner

Detailed Description

Definition at line 9 of file BaseReader.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::__construct ( )

IReader constructor.

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 59 of file BaseReader.php.

     {
         $this->readFilter = new DefaultReadFilter();
     }

Member Function Documentation

◆ getIncludeCharts()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::getIncludeCharts ( )

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: bool

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 88 of file BaseReader.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$includeCharts.

     {
         return $this->includeCharts;
     }

◆ getLoadSheetsOnly()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::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.

Returns: mixed

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 100 of file BaseReader.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$loadSheetsOnly.

     {
         return $this->loadSheetsOnly;
     }

◆ getReadDataOnly()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::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.

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

Returns: bool

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 64 of file BaseReader.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$readDataOnly.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xlsx\getFromZipArchive().

     {
         return $this->readDataOnly;
     }

Here is the caller graph for this function:

◆ getReadEmptyCells()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::getReadEmptyCells ( )

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: bool

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 76 of file BaseReader.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$readEmptyCells.

     {
         return $this->readEmptyCells;
     }

◆ getReadFilter()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::getReadFilter ( )

Read filter.

Returns: IReadFilter

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 123 of file BaseReader.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$readFilter.

     {
         return $this->readFilter;
     }

Here is the caller graph for this function:

◆ getSecurityScanner()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::getSecurityScanner ( )

Definition at line 135 of file BaseReader.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$securityScanner.

     {
         return $this->securityScanner;
     }

◆ openFile()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::openFile ( $pFilename )

protected

Open file for reading.

Parameters

string $pFilename

Definition at line 145 of file BaseReader.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$fileHandle, and PhpOffice\PhpSpreadsheet\Shared\File\assertFile().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Slk\canRead(), PhpOffice\PhpSpreadsheet\Reader\Html\canRead(), PhpOffice\PhpSpreadsheet\Reader\Csv\canRead(), PhpOffice\PhpSpreadsheet\Reader\Slk\canReadOrBust(), and PhpOffice\PhpSpreadsheet\Reader\Csv\openFileOrMemory().

                                            : void
     {
         if ($pFilename) {
             File::assertFile($pFilename);
 
             // Open file
             $fileHandle = fopen($pFilename, 'rb');
         } else {
             $fileHandle = false;
         }
         if ($fileHandle !== false) {
             $this->fileHandle = $fileHandle;
         } else {
             throw new ReaderException('Could not open file ' . $pFilename . ' for reading.');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIncludeCharts()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::setIncludeCharts ( $pValue )

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

bool $pValue

Returns: IReader

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 93 of file BaseReader.php.

     {
         $this->includeCharts = (bool) $pValue;
 
         return $this;
     }

◆ setLoadAllSheets()

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

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

Returns: IReader

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 116 of file BaseReader.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\BaseReader\setLoadSheetsOnly().

     {
         $this->loadSheetsOnly = null;
 
         return $this;
     }

Here is the caller graph for this function:

◆ setLoadSheetsOnly()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::setLoadSheetsOnly ( $value )

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: IReader

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 105 of file BaseReader.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\setLoadAllSheets().

     {
         if ($value === null) {
             return $this->setLoadAllSheets();
         }
 
         $this->loadSheetsOnly = is_array($value) ? $value : [$value];
 
         return $this;
     }

Here is the call graph for this function:

◆ setReadDataOnly()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::setReadDataOnly ( $pValue )

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

bool $pValue

Returns: IReader

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 69 of file BaseReader.php.

     {
         $this->readDataOnly = (bool) $pValue;
 
         return $this;
     }

◆ setReadEmptyCells()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::setReadEmptyCells ( $pValue )

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

bool $pValue

Returns: IReader

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 81 of file BaseReader.php.

     {
         $this->readEmptyCells = (bool) $pValue;
 
         return $this;
     }

◆ setReadFilter()

PhpOffice\PhpSpreadsheet\Reader\BaseReader::setReadFilter ( IReadFilter $pValue )

Set read filter.

Returns: IReader

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 128 of file BaseReader.php.

     {
         $this->readFilter = $pValue;
 
         return $this;
     }

Field Documentation

◆ $fileHandle

PhpOffice\PhpSpreadsheet\Reader\BaseReader::$fileHandle

protected

Definition at line 52 of file BaseReader.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Slk\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Csv\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting(), PhpOffice\PhpSpreadsheet\Reader\Slk\loadIntoExisting(), and PhpOffice\PhpSpreadsheet\Reader\BaseReader\openFile().

◆ $includeCharts

PhpOffice\PhpSpreadsheet\Reader\BaseReader::$includeCharts = false

protected

Definition at line 35 of file BaseReader.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\BaseReader\getIncludeCharts().

◆ $loadSheetsOnly

PhpOffice\PhpSpreadsheet\Reader\BaseReader::$loadSheetsOnly

protected

Definition at line 43 of file BaseReader.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\BaseReader\getLoadSheetsOnly().

◆ $readDataOnly

PhpOffice\PhpSpreadsheet\Reader\BaseReader::$readDataOnly = false

protected

Definition at line 18 of file BaseReader.php.

◆ $readEmptyCells

PhpOffice\PhpSpreadsheet\Reader\BaseReader::$readEmptyCells = true

protected

Definition at line 27 of file BaseReader.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\BaseReader\getReadEmptyCells().

◆ $readFilter

PhpOffice\PhpSpreadsheet\Reader\BaseReader::$readFilter

protected

Definition at line 50 of file BaseReader.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\BaseReader\getReadFilter(), and PhpOffice\PhpSpreadsheet\Reader\Xlsx\ColumnAndRowAttributes\load().

◆ $securityScanner

PhpOffice\PhpSpreadsheet\Reader\BaseReader::$securityScanner

protected

Definition at line 57 of file BaseReader.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\BaseReader\getSecurityScanner().

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Reader/BaseReader.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getIncludeCharts()

◆ getLoadSheetsOnly()

◆ getReadDataOnly()

◆ getReadEmptyCells()

◆ getReadFilter()

◆ getSecurityScanner()

◆ openFile()

◆ setIncludeCharts()

◆ setLoadAllSheets()

◆ setLoadSheetsOnly()

◆ setReadDataOnly()

◆ setReadEmptyCells()

◆ setReadFilter()

Field Documentation

◆ $fileHandle

◆ $includeCharts

◆ $loadSheetsOnly

◆ $readDataOnly

◆ $readEmptyCells

◆ $readFilter

◆ $securityScanner