Inheritance diagram for PHPExcel_Reader_CSV:

Collaboration diagram for PHPExcel_Reader_CSV:

Public Member Functions
	__construct ()
	Create a new PHPExcel_Reader_CSV. More...

	setInputEncoding ($pValue='UTF-8')
	Set input encoding. More...

	getInputEncoding ()
	Get input encoding. More...

	listWorksheetInfo ($pFilename)
	Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns) More...

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

	loadIntoExisting ($pFilename, PHPExcel $objPHPExcel)
	Loads PHPExcel from file into PHPExcel instance. More...

	getDelimiter ()
	Get delimiter. More...

	setDelimiter ($pValue=',')
	Set delimiter. More...

	getEnclosure ()
	Get enclosure. More...

	setEnclosure ($pValue='"')
	Set enclosure. More...

	getSheetIndex ()
	Get sheet index. More...

	setSheetIndex ($pValue=0)
	Set sheet index. More...

	setContiguous ($contiguous=FALSE)
	Set Contiguous. More...

	getContiguous ()
	Get Contiguous. More...

Public Member Functions inherited from 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. 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...

Protected Member Functions
	_isValidFormat ()
	Validate that the current file is a CSV file. More...

	_skipBOM ()
	Move filepointer past any BOM marker. More...

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

Private Attributes
	$_inputEncoding = 'UTF-8'

	$_delimiter = ','

	$_enclosure = '"'

	$_sheetIndex = 0

	$_contiguous = false

	$_contiguousRow = -1

Additional Inherited Members
Protected Attributes inherited from PHPExcel_Reader_Abstract
	$_readDataOnly = FALSE

	$_includeCharts = FALSE

	$_loadSheetsOnly = NULL

	$_readFilter = NULL

	$_fileHandle = NULL

Detailed Description

Definition at line 45 of file CSV.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Reader_CSV::__construct ( )

Create a new PHPExcel_Reader_CSV.

Definition at line 98 of file CSV.php.

                                       {
                 $this->_readFilter              = new PHPExcel_Reader_DefaultReadFilter();
         }

Member Function Documentation

◆ _isValidFormat()

PHPExcel_Reader_CSV::_isValidFormat ( )

protected

Validate that the current file is a CSV file.

Returns: boolean

Definition at line 107 of file CSV.php.

Referenced by listWorksheetInfo(), and loadIntoExisting().

         {
                 return TRUE;
         }

Here is the caller graph for this function:

◆ _skipBOM()

PHPExcel_Reader_CSV::_skipBOM ( )

protected

Move filepointer past any BOM marker.

Definition at line 137 of file CSV.php.

Referenced by listWorksheetInfo(), and loadIntoExisting().

         {
                 rewind($this->_fileHandle);
 
                 switch ($this->_inputEncoding) {
                         case 'UTF-8':
                                 fgets($this->_fileHandle, 4) == "\xEF\xBB\xBF" ?
                                         fseek($this->_fileHandle, 3) : fseek($this->_fileHandle, 0);
                                 break;
                         case 'UTF-16LE':
                                 fgets($this->_fileHandle, 3) == "\xFF\xFE" ?
                                         fseek($this->_fileHandle, 2) : fseek($this->_fileHandle, 0);
                                 break;
                         case 'UTF-16BE':
                                 fgets($this->_fileHandle, 3) == "\xFE\xFF" ?
                                         fseek($this->_fileHandle, 2) : fseek($this->_fileHandle, 0);
                                 break;
                         case 'UTF-32LE':
                                 fgets($this->_fileHandle, 5) == "\xFF\xFE\x00\x00" ?
                                         fseek($this->_fileHandle, 4) : fseek($this->_fileHandle, 0);
                                 break;
                         case 'UTF-32BE':
                                 fgets($this->_fileHandle, 5) == "\x00\x00\xFE\xFF" ?
                                         fseek($this->_fileHandle, 4) : fseek($this->_fileHandle, 0);
                                 break;
                         default:
                                 break;
                 }
         }

Here is the caller graph for this function:

◆ getContiguous()

PHPExcel_Reader_CSV::getContiguous ( )

Get Contiguous.

Returns: boolean

Definition at line 383 of file CSV.php.

References $_contiguous.

                                         {
                 return $this->_contiguous;
         }

◆ getDelimiter()

PHPExcel_Reader_CSV::getDelimiter ( )

Get delimiter.

Returns: string

Definition at line 305 of file CSV.php.

References $_delimiter.

                                        {
                 return $this->_delimiter;
         }

◆ getEnclosure()

PHPExcel_Reader_CSV::getEnclosure ( )

Get enclosure.

Returns: string

Definition at line 325 of file CSV.php.

References $_enclosure.

                                        {
                 return $this->_enclosure;
         }

◆ getInputEncoding()

PHPExcel_Reader_CSV::getInputEncoding ( )

Get input encoding.

Returns: string

Definition at line 128 of file CSV.php.

References $_inputEncoding.

         {
                 return $this->_inputEncoding;
         }

◆ getSheetIndex()

PHPExcel_Reader_CSV::getSheetIndex ( )

Get sheet index.

Returns: integer

Definition at line 348 of file CSV.php.

References $_sheetIndex.

                                         {
                 return $this->_sheetIndex;
         }

◆ listWorksheetInfo()

PHPExcel_Reader_CSV::listWorksheetInfo ( $pFilename )

Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns)

Parameters

string $pFilename

Exceptions

PHPExcel_Reader_Exception

Definition at line 173 of file CSV.php.

References PHPExcel_Reader_Abstract\$_fileHandle, _isValidFormat(), PHPExcel_Reader_Abstract\_openFile(), _skipBOM(), array, and PHPExcel_Cell\stringFromColumnIndex().

         {
                 // Open file
                 $this->_openFile($pFilename);
                 if (!$this->_isValidFormat()) {
                         fclose ($this->_fileHandle);
                         throw new PHPExcel_Reader_Exception($pFilename . " is an Invalid Spreadsheet file.");
                 }
                 $fileHandle = $this->_fileHandle;
 
                 // Skip BOM, if any
                 $this->_skipBOM();
 
                 $escapeEnclosures = array( "\\" . $this->_enclosure, $this->_enclosure . $this->_enclosure );
 
                 $worksheetInfo = array();
                 $worksheetInfo[0]['worksheetName'] = 'Worksheet';
                 $worksheetInfo[0]['lastColumnLetter'] = 'A';
                 $worksheetInfo[0]['lastColumnIndex'] = 0;
                 $worksheetInfo[0]['totalRows'] = 0;
                 $worksheetInfo[0]['totalColumns'] = 0;
 
                 // Loop through each line of the file in turn
                 while (($rowData = fgetcsv($fileHandle, 0, $this->_delimiter, $this->_enclosure)) !== FALSE) {
                         $worksheetInfo[0]['totalRows']++;
                         $worksheetInfo[0]['lastColumnIndex'] = max($worksheetInfo[0]['lastColumnIndex'], count($rowData) - 1);
                 }
 
                 $worksheetInfo[0]['lastColumnLetter'] = PHPExcel_Cell::stringFromColumnIndex($worksheetInfo[0]['lastColumnIndex']);
                 $worksheetInfo[0]['totalColumns'] = $worksheetInfo[0]['lastColumnIndex'] + 1;
 
                 // Close file
                 fclose($fileHandle);
 
                 return $worksheetInfo;
         }

Here is the call graph for this function:

◆ load()

PHPExcel_Reader_CSV::load ( $pFilename )

Loads PHPExcel from file.

Parameters

string $pFilename

Returns: PHPExcel

Exceptions

PHPExcel_Reader_Exception

Implements PHPExcel_Reader_IReader.

Definition at line 217 of file CSV.php.

References $objPHPExcel, and loadIntoExisting().

         {
                 // Create new PHPExcel
                 $objPHPExcel = new PHPExcel();
 
                 // Load into this instance
                 return $this->loadIntoExisting($pFilename, $objPHPExcel);
         }

Here is the call graph for this function:

◆ loadIntoExisting()

PHPExcel_Reader_CSV::loadIntoExisting	(		$pFilename,
		PHPExcel	$objPHPExcel
	)

Loads PHPExcel from file into PHPExcel instance.

Parameters

string	$pFilename
PHPExcel	$objPHPExcel

Returns: PHPExcel

Exceptions

PHPExcel_Reader_Exception

Definition at line 234 of file CSV.php.

References $_contiguousRow, PHPExcel_Reader_Abstract\$_fileHandle, $_sheetIndex, $objPHPExcel, _isValidFormat(), PHPExcel_Reader_Abstract\_openFile(), _skipBOM(), array, PHPExcel_Shared_String\ConvertEncoding(), PHPExcel\createSheet(), PHPExcel\getSheetCount(), and PHPExcel\setActiveSheetIndex().

Referenced by load().

         {
                 $lineEnding = ini_get('auto_detect_line_endings');
                 ini_set('auto_detect_line_endings', true);
 
                 // Open file
                 $this->_openFile($pFilename);
                 if (!$this->_isValidFormat()) {
                         fclose ($this->_fileHandle);
                         throw new PHPExcel_Reader_Exception($pFilename . " is an Invalid Spreadsheet file.");
                 }
                 $fileHandle = $this->_fileHandle;
 
                 // Skip BOM, if any
                 $this->_skipBOM();
 
                 // Create new PHPExcel object
                 while ($objPHPExcel->getSheetCount() <= $this->_sheetIndex) {
                         $objPHPExcel->createSheet();
                 }
                 $sheet = $objPHPExcel->setActiveSheetIndex($this->_sheetIndex);
 
                 $escapeEnclosures = array( "\\" . $this->_enclosure,
                                                                    $this->_enclosure . $this->_enclosure
                                                                  );
 
                 // Set our starting row based on whether we're in contiguous mode or not
                 $currentRow = 1;
                 if ($this->_contiguous) {
                         $currentRow = ($this->_contiguousRow == -1) ? $sheet->getHighestRow(): $this->_contiguousRow;
                 }
 
                 // Loop through each line of the file in turn
                 while (($rowData = fgetcsv($fileHandle, 0, $this->_delimiter, $this->_enclosure)) !== FALSE) {
                         $columnLetter = 'A';
                         foreach($rowData as $rowDatum) {
                                 if ($rowDatum != '' && $this->_readFilter->readCell($columnLetter, $currentRow)) {
                                         // Unescape enclosures
                                         $rowDatum = str_replace($escapeEnclosures, $this->_enclosure, $rowDatum);
 
                                         // Convert encoding if necessary
                                         if ($this->_inputEncoding !== 'UTF-8') {
                                                 $rowDatum = PHPExcel_Shared_String::ConvertEncoding($rowDatum, 'UTF-8', $this->_inputEncoding);
                                         }
 
                                         // Set cell value
                                         $sheet->getCell($columnLetter . $currentRow)->setValue($rowDatum);
                                 }
                                 ++$columnLetter;
                         }
                         ++$currentRow;
                 }
 
                 // Close file
                 fclose($fileHandle);
 
                 if ($this->_contiguous) {
                         $this->_contiguousRow = $currentRow;
                 }
 
                 ini_set('auto_detect_line_endings', $lineEnding);
 
                 // Return
                 return $objPHPExcel;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setContiguous()

PHPExcel_Reader_CSV::setContiguous ( $contiguous = FALSE )

Set Contiguous.

Parameters

boolean $contiguous

Definition at line 368 of file CSV.php.

         {
                 $this->_contiguous = (bool) $contiguous;
                 if (!$contiguous) {
                         $this->_contiguousRow = -1;
                 }
 
                 return $this;
         }

◆ setDelimiter()

PHPExcel_Reader_CSV::setDelimiter ( $pValue = ',' )

Set delimiter.

Parameters

string $pValue Delimiter, defaults to ,

Returns: PHPExcel_Reader_CSV

Definition at line 315 of file CSV.php.

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

◆ setEnclosure()

PHPExcel_Reader_CSV::setEnclosure ( $pValue = '"' )

Set enclosure.

Parameters

string $pValue Enclosure, defaults to "

Returns: PHPExcel_Reader_CSV

Definition at line 335 of file CSV.php.

                                                     {
                 if ($pValue == '') {
                         $pValue = '"';
                 }
                 $this->_enclosure = $pValue;
                 return $this;
         }

◆ setInputEncoding()

PHPExcel_Reader_CSV::setInputEncoding ( $pValue = 'UTF-8' )

Set input encoding.

Parameters

string $pValue Input encoding

Definition at line 117 of file CSV.php.

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

◆ setSheetIndex()

PHPExcel_Reader_CSV::setSheetIndex ( $pValue = 0 )

Set sheet index.

Parameters

integer $pValue Sheet index

Returns: PHPExcel_Reader_CSV

Definition at line 358 of file CSV.php.

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

Field Documentation

◆ $_contiguous

PHPExcel_Reader_CSV::$_contiguous = false

private

Definition at line 85 of file CSV.php.

Referenced by getContiguous().

◆ $_contiguousRow

PHPExcel_Reader_CSV::$_contiguousRow = -1

private

Definition at line 92 of file CSV.php.

Referenced by loadIntoExisting().

◆ $_delimiter

PHPExcel_Reader_CSV::$_delimiter = ','

private

Definition at line 61 of file CSV.php.

Referenced by getDelimiter().

◆ $_enclosure

PHPExcel_Reader_CSV::$_enclosure = '"'

private

Definition at line 69 of file CSV.php.

Referenced by getEnclosure().

◆ $_inputEncoding

PHPExcel_Reader_CSV::$_inputEncoding = 'UTF-8'

private

Definition at line 53 of file CSV.php.

Referenced by getInputEncoding().

◆ $_sheetIndex

PHPExcel_Reader_CSV::$_sheetIndex = 0

private

Definition at line 77 of file CSV.php.

Referenced by getSheetIndex(), and loadIntoExisting().

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _isValidFormat()

◆ _skipBOM()

◆ getContiguous()

◆ getDelimiter()

◆ getEnclosure()

◆ getInputEncoding()

◆ getSheetIndex()

◆ listWorksheetInfo()

◆ load()

◆ loadIntoExisting()

◆ setContiguous()

◆ setDelimiter()

◆ setEnclosure()

◆ setInputEncoding()

◆ setSheetIndex()

Field Documentation

◆ $_contiguous

◆ $_contiguousRow

◆ $_delimiter

◆ $_enclosure

◆ $_inputEncoding

◆ $_sheetIndex