Inheritance diagram for PHPExcel_Reader_Abstract:

Collaboration diagram for PHPExcel_Reader_Abstract:

Public Member Functions
	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=FALSE)
	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...

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

	setIncludeCharts ($pValue=FALSE)
	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=NULL)
	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 (PHPExcel_Reader_IReadFilter $pValue)
	Set read filter. More...

	canRead ($pFilename)
	Can the current PHPExcel_Reader_IReader read the file? More...

	securityScan ($xml)
	Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks. More...

	securityScanFile ($filestream)
	Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks. More...

Public Member Functions inherited from PHPExcel_Reader_IReader
	load ($pFilename)
	Loads PHPExcel from file. More...

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

Protected Attributes
	$_readDataOnly = FALSE

	$_includeCharts = FALSE

	$_loadSheetsOnly = NULL

	$_readFilter = NULL

	$_fileHandle = NULL

Detailed Description

Definition at line 36 of file Abstract.php.

Member Function Documentation

◆ _openFile()

PHPExcel_Reader_Abstract::_openFile ( $pFilename )

protected

Open file for reading.

Parameters

string $pFilename

Exceptions

PHPExcel_Reader_Exception

Returns: resource

Definition at line 195 of file Abstract.php.

Referenced by PHPExcel_Reader_Excel2003XML\canRead(), canRead(), PHPExcel_Reader_SYLK\listWorksheetInfo(), PHPExcel_Reader_CSV\listWorksheetInfo(), PHPExcel_Reader_SYLK\loadIntoExisting(), PHPExcel_Reader_CSV\loadIntoExisting(), and PHPExcel_Reader_HTML\loadIntoExisting().

         {
                 // Check if file exists
                 if (!file_exists($pFilename) || !is_readable($pFilename)) {
                         throw new PHPExcel_Reader_Exception("Could not open " . $pFilename . " for reading! File does not exist.");
                 }
 
                 // Open file
                 $this->_fileHandle = fopen($pFilename, 'r');
                 if ($this->_fileHandle === FALSE) {
                         throw new PHPExcel_Reader_Exception("Could not open file " . $pFilename . " for reading.");
                 }
         }

Here is the caller graph for this function:

◆ canRead()

PHPExcel_Reader_Abstract::canRead ( $pFilename )

Can the current PHPExcel_Reader_IReader read the file?

Parameters

string $pFilename

Returns: boolean

Exceptions

PHPExcel_Reader_Exception

Implements PHPExcel_Reader_IReader.

Definition at line 216 of file Abstract.php.

References _openFile().

         {
                 // Check if file exists
                 try {
                         $this->_openFile($pFilename);
                 } catch (Exception $e) {
                         return FALSE;
                 }
 
                 $readable = $this->_isValidFormat();
                 fclose ($this->_fileHandle);
                 return $readable;
         }

Here is the call graph for this function:

◆ getIncludeCharts()

PHPExcel_Reader_Abstract::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: boolean

Definition at line 106 of file Abstract.php.

References $_includeCharts.

                                            {
                 return $this->_includeCharts;
         }

◆ getLoadSheetsOnly()

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

Definition at line 132 of file Abstract.php.

References $_loadSheetsOnly.

         {
                 return $this->_loadSheetsOnly;
         }

◆ getReadDataOnly()

PHPExcel_Reader_Abstract::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: boolean

Definition at line 80 of file Abstract.php.

References $_readDataOnly.

                                           {
                 return $this->_readDataOnly;
         }

◆ getReadFilter()

PHPExcel_Reader_Abstract::getReadFilter ( )

Read filter.

Returns: PHPExcel_Reader_IReadFilter

Definition at line 173 of file Abstract.php.

References $_readFilter.

                                         {
                 return $this->_readFilter;
         }

Here is the caller graph for this function:

◆ securityScan()

PHPExcel_Reader_Abstract::securityScan ( $xml )

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks.

Parameters

string $xml

Exceptions

PHPExcel_Reader_Exception

Definition at line 236 of file Abstract.php.

         {
         $pattern = '/\\0?' . implode('\\0?', str_split('<!DOCTYPE')) . '\\0?/';
         if (preg_match($pattern, $xml)) { 
             throw new PHPExcel_Reader_Exception('Detected use of ENTITY in XML, spreadsheet file load() aborted to prevent XXE/XEE attacks');
         }
         return $xml;
     }

Here is the caller graph for this function:

◆ securityScanFile()

PHPExcel_Reader_Abstract::securityScanFile ( $filestream )

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks.

Parameters

string $filestream

Exceptions

PHPExcel_Reader_Exception

Definition at line 251 of file Abstract.php.

References securityScan().

Referenced by PHPExcel_Reader_Gnumeric\listWorksheetInfo(), PHPExcel_Reader_Excel2007\listWorksheetInfo(), PHPExcel_Reader_OOCalc\listWorksheetInfo(), PHPExcel_Reader_Gnumeric\listWorksheetNames(), PHPExcel_Reader_OOCalc\listWorksheetNames(), and PHPExcel_Reader_HTML\loadIntoExisting().

         {
         return $this->securityScan(file_get_contents($filestream));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIncludeCharts()

PHPExcel_Reader_Abstract::setIncludeCharts ( $pValue = FALSE )

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

Definition at line 120 of file Abstract.php.

                                                           {
                 $this->_includeCharts = (boolean) $pValue;
                 return $this;
         }

◆ setLoadAllSheets()

PHPExcel_Reader_Abstract::setLoadAllSheets ( )

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

Returns: PHPExcel_Reader_IReader

Definition at line 162 of file Abstract.php.

Referenced by setLoadSheetsOnly().

         {
                 $this->_loadSheetsOnly = NULL;
                 return $this;
         }

Here is the caller graph for this function:

◆ setLoadSheetsOnly()

PHPExcel_Reader_Abstract::setLoadSheetsOnly ( $value = NULL )

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

Definition at line 146 of file Abstract.php.

References array, and setLoadAllSheets().

         {
         if ($value === NULL)
             return $this->setLoadAllSheets();
 
         $this->_loadSheetsOnly = is_array($value) ?
                         $value : array($value);
                 return $this;
         }

Here is the call graph for this function:

◆ setReadDataOnly()

PHPExcel_Reader_Abstract::setReadDataOnly ( $pValue = FALSE )

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

Definition at line 93 of file Abstract.php.

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

◆ setReadFilter()

PHPExcel_Reader_Abstract::setReadFilter ( PHPExcel_Reader_IReadFilter $pValue )

Set read filter.

Parameters

PHPExcel_Reader_IReadFilter $pValue

Returns: PHPExcel_Reader_IReader

Definition at line 183 of file Abstract.php.

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

Field Documentation

◆ $_fileHandle

PHPExcel_Reader_Abstract::$_fileHandle = NULL

protected

Definition at line 70 of file Abstract.php.

Referenced by PHPExcel_Reader_Excel2003XML\canRead(), PHPExcel_Reader_SYLK\listWorksheetInfo(), PHPExcel_Reader_CSV\listWorksheetInfo(), PHPExcel_Reader_SYLK\loadIntoExisting(), and PHPExcel_Reader_CSV\loadIntoExisting().

◆ $_includeCharts

PHPExcel_Reader_Abstract::$_includeCharts = FALSE

protected

Definition at line 53 of file Abstract.php.

Referenced by getIncludeCharts().

◆ $_loadSheetsOnly

PHPExcel_Reader_Abstract::$_loadSheetsOnly = NULL

protected

Definition at line 61 of file Abstract.php.

Referenced by getLoadSheetsOnly().

◆ $_readDataOnly

PHPExcel_Reader_Abstract::$_readDataOnly = FALSE

protected

Definition at line 45 of file Abstract.php.

Referenced by getReadDataOnly().

◆ $_readFilter

PHPExcel_Reader_Abstract::$_readFilter = NULL

protected

Definition at line 68 of file Abstract.php.

Referenced by getReadFilter().

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

libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Reader/Abstract.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _openFile()

◆ canRead()

◆ getIncludeCharts()

◆ getLoadSheetsOnly()

◆ getReadDataOnly()

◆ getReadFilter()

◆ securityScan()

◆ securityScanFile()

◆ setIncludeCharts()

◆ setLoadAllSheets()

◆ setLoadSheetsOnly()

◆ setReadDataOnly()

◆ setReadFilter()

Field Documentation

◆ $_fileHandle

◆ $_includeCharts

◆ $_loadSheetsOnly

◆ $_readDataOnly

◆ $_readFilter