Inheritance diagram for PHPExcel_Writer_CSV:

Collaboration diagram for PHPExcel_Writer_CSV:

Public Member Functions
	__construct (PHPExcel $phpExcel)
	Create a new PHPExcel_Writer_CSV. More...

	save ($pFilename=null)
	Save PHPExcel to file. More...

	getDelimiter ()
	Get delimiter. More...

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

	getEnclosure ()
	Get enclosure. More...

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

	getLineEnding ()
	Get line ending. More...

	setLineEnding ($pValue=PHP_EOL)
	Set line ending. More...

	getUseBOM ()
	Get whether BOM should be used. More...

	setUseBOM ($pValue=false)
	Set whether BOM should be used. More...

	getExcelCompatibility ()
	Get whether the file should be saved with full Excel Compatibility. More...

	setExcelCompatibility ($pValue=false)
	Set whether the file should be saved with full Excel Compatibility. More...

	getSheetIndex ()
	Get sheet index. More...

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

Public Member Functions inherited from PHPExcel_Writer_Abstract
	getIncludeCharts ()
	Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PHPExcel object. More...

	setIncludeCharts ($pValue=FALSE)
	Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PHPExcel object. More...

	getPreCalculateFormulas ()
	Get Pre-Calculate Formulas flag If this is true (the default), then the writer will recalculate all formulae in a workbook when saving, so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet viewer when opening the file If false, then formulae are not calculated on save. More...

	setPreCalculateFormulas ($pValue=TRUE)
	Set Pre-Calculate Formulas Set to true (the default) to advise the Writer to calculate all formulae on save Set to false to prevent precalculation of formulae on save. More...

	getUseDiskCaching ()
	Get use disk caching where possible? More...

	setUseDiskCaching ($pValue=FALSE, $pDirectory=NULL)
	Set use disk caching where possible? More...

	getDiskCachingDirectory ()
	Get disk caching directory. More...

Private Member Functions
	_writeLine ($pFileHandle=null, $pValues=null)
	Write line to CSV file. More...

Private Attributes
	$_phpExcel

	$_delimiter = ','

	$_enclosure = '"'

	$_lineEnding = PHP_EOL

	$_sheetIndex = 0

	$_useBOM = false

	$_excelCompatibility = false

Additional Inherited Members
Protected Attributes inherited from PHPExcel_Writer_Abstract
	$_includeCharts = FALSE

	$_preCalculateFormulas = TRUE

	$_useDiskCaching = FALSE

	$_diskCachingDirectory = './'

Detailed Description

Definition at line 36 of file CSV.php.

Constructor & Destructor Documentation

◆ __construct()

PHPExcel_Writer_CSV::__construct ( PHPExcel $phpExcel )

Create a new PHPExcel_Writer_CSV.

Parameters

PHPExcel $phpExcel PHPExcel object

Definition at line 91 of file CSV.php.

                                                         {
                 $this->_phpExcel        = $phpExcel;
         }

Member Function Documentation

◆ _writeLine()

PHPExcel_Writer_CSV::_writeLine	(	$pFileHandle = `null`,
		$pValues = `null`
	)

private

Write line to CSV file.

Parameters

mixed	$pFileHandle	PHP filehandle
array	$pValues	Array containing values in a row

Exceptions

PHPExcel_Writer_Exception

Definition at line 277 of file CSV.php.

References $_delimiter, $_enclosure, and $_lineEnding.

Referenced by save().

                                                                           {
                 if (is_array($pValues)) {
                         // No leading delimiter
                         $writeDelimiter = false;
 
                         // Build the line
                         $line = '';
 
                         foreach ($pValues as $element) {
                                 // Escape enclosures
                                 $element = str_replace($this->_enclosure, $this->_enclosure . $this->_enclosure, $element);
 
                                 // Add delimiter
                                 if ($writeDelimiter) {
                                         $line .= $this->_delimiter;
                                 } else {
                                         $writeDelimiter = true;
                                 }
 
                                 // Add enclosed string
                                 $line .= $this->_enclosure . $element . $this->_enclosure;
                         }
 
                         // Add line ending
                         $line .= $this->_lineEnding;
 
                         // Write to file
             fwrite($pFileHandle, $line);
                 } else {
                         throw new PHPExcel_Writer_Exception("Invalid data row passed to CSV writer.");
                 }
         }

Here is the caller graph for this function:

◆ getDelimiter()

PHPExcel_Writer_CSV::getDelimiter ( )

Get delimiter.

Returns: string

Definition at line 151 of file CSV.php.

References $_delimiter.

Referenced by save().

                                        {
                 return $this->_delimiter;
         }

Here is the caller graph for this function:

◆ getEnclosure()

PHPExcel_Writer_CSV::getEnclosure ( )

Get enclosure.

Returns: string

Definition at line 171 of file CSV.php.

References $_enclosure.

                                        {
                 return $this->_enclosure;
         }

◆ getExcelCompatibility()

PHPExcel_Writer_CSV::getExcelCompatibility ( )

Get whether the file should be saved with full Excel Compatibility.

Returns: boolean

Definition at line 234 of file CSV.php.

References $_excelCompatibility.

                                                 {
                 return $this->_excelCompatibility;
         }

◆ getLineEnding()

PHPExcel_Writer_CSV::getLineEnding ( )

Get line ending.

Returns: string

Definition at line 194 of file CSV.php.

References $_lineEnding.

                                         {
                 return $this->_lineEnding;
         }

◆ getSheetIndex()

PHPExcel_Writer_CSV::getSheetIndex ( )

Get sheet index.

Returns: int

Definition at line 255 of file CSV.php.

References $_sheetIndex.

                                         {
                 return $this->_sheetIndex;
         }

◆ getUseBOM()

PHPExcel_Writer_CSV::getUseBOM ( )

Get whether BOM should be used.

Returns: boolean

Definition at line 214 of file CSV.php.

References $_useBOM.

                                     {
                 return $this->_useBOM;
         }

◆ save()

PHPExcel_Writer_CSV::save ( $pFilename = null )

Save PHPExcel to file.

Parameters

string $pFilename

Exceptions

PHPExcel_Writer_Exception

Implements PHPExcel_Writer_IWriter.

Definition at line 101 of file CSV.php.

References $row, _writeLine(), PHPExcel_Calculation\getArrayReturnType(), getDelimiter(), PHPExcel_Calculation\getInstance(), PHPExcel_Calculation\RETURN_ARRAY_AS_VALUE, PHPExcel_Calculation\setArrayReturnType(), setDelimiter(), setEnclosure(), and setLineEnding().

                                                 {
                 // Fetch sheet
                 $sheet = $this->_phpExcel->getSheet($this->_sheetIndex);
 
                 $saveDebugLog = PHPExcel_Calculation::getInstance($this->_phpExcel)->getDebugLog()->getWriteDebugLog();
                 PHPExcel_Calculation::getInstance($this->_phpExcel)->getDebugLog()->setWriteDebugLog(FALSE);
                 $saveArrayReturnType = PHPExcel_Calculation::getArrayReturnType();
                 PHPExcel_Calculation::setArrayReturnType(PHPExcel_Calculation::RETURN_ARRAY_AS_VALUE);
 
                 // Open file
                 $fileHandle = fopen($pFilename, 'wb+');
                 if ($fileHandle === false) {
                         throw new PHPExcel_Writer_Exception("Could not open file $pFilename for writing.");
                 }
 
                 if ($this->_excelCompatibility) {
                         fwrite($fileHandle, "\xEF\xBB\xBF");    //      Enforce UTF-8 BOM Header
                         $this->setEnclosure('"');                               //      Set enclosure to "
                         $this->setDelimiter(";");                           //  Set delimiter to a semi-colon
             $this->setLineEnding("\r\n");
                         fwrite($fileHandle, 'sep=' . $this->getDelimiter() . $this->_lineEnding);
                 } elseif ($this->_useBOM) {
                         // Write the UTF-8 BOM code if required
                         fwrite($fileHandle, "\xEF\xBB\xBF");
                 }
 
                 //      Identify the range that we need to extract from the worksheet
                 $maxCol = $sheet->getHighestDataColumn();
                 $maxRow = $sheet->getHighestDataRow();
 
                 // Write rows to file
                 for($row = 1; $row <= $maxRow; ++$row) {
                         // Convert the row to an array...
                         $cellsArray = $sheet->rangeToArray('A'.$row.':'.$maxCol.$row,'', $this->_preCalculateFormulas);
                         // ... and write to the file
                         $this->_writeLine($fileHandle, $cellsArray[0]);
                 }
 
                 // Close file
                 fclose($fileHandle);
 
                 PHPExcel_Calculation::setArrayReturnType($saveArrayReturnType);
                 PHPExcel_Calculation::getInstance($this->_phpExcel)->getDebugLog()->setWriteDebugLog($saveDebugLog);
         }

Here is the call graph for this function:

◆ setDelimiter()

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

Set delimiter.

Parameters

string $pValue Delimiter, defaults to ,

Returns: PHPExcel_Writer_CSV

Definition at line 161 of file CSV.php.

Referenced by save().

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

Here is the caller graph for this function:

◆ setEnclosure()

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

Set enclosure.

Parameters

string $pValue Enclosure, defaults to "

Returns: PHPExcel_Writer_CSV

Definition at line 181 of file CSV.php.

Referenced by save().

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

Here is the caller graph for this function:

◆ setExcelCompatibility()

PHPExcel_Writer_CSV::setExcelCompatibility ( $pValue = false )

Set whether the file should be saved with full Excel Compatibility.

Parameters

boolean $pValue Set the file to be written as a fully Excel compatible csv file Note that this overrides other settings such as useBOM, enclosure and delimiter

Returns: PHPExcel_Writer_CSV

Definition at line 245 of file CSV.php.

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

◆ setLineEnding()

PHPExcel_Writer_CSV::setLineEnding ( $pValue = PHP_EOL )

Set line ending.

Parameters

string $pValue Line ending, defaults to OS line ending (PHP_EOL)

Returns: PHPExcel_Writer_CSV

Definition at line 204 of file CSV.php.

Referenced by save().

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

Here is the caller graph for this function:

◆ setSheetIndex()

PHPExcel_Writer_CSV::setSheetIndex ( $pValue = 0 )

Set sheet index.

Parameters

int $pValue Sheet index

Returns: PHPExcel_Writer_CSV

Definition at line 265 of file CSV.php.

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

◆ setUseBOM()

PHPExcel_Writer_CSV::setUseBOM ( $pValue = false )

Set whether BOM should be used.

Parameters

boolean $pValue Use UTF-8 byte-order mark? Defaults to false

Returns: PHPExcel_Writer_CSV

Definition at line 224 of file CSV.php.

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

Field Documentation

◆ $_delimiter

PHPExcel_Writer_CSV::$_delimiter = ','

private

Definition at line 49 of file CSV.php.

Referenced by _writeLine(), and getDelimiter().

◆ $_enclosure

PHPExcel_Writer_CSV::$_enclosure = '"'

private

Definition at line 56 of file CSV.php.

Referenced by _writeLine(), and getEnclosure().

◆ $_excelCompatibility

PHPExcel_Writer_CSV::$_excelCompatibility = false

private

Definition at line 84 of file CSV.php.

Referenced by getExcelCompatibility().

◆ $_lineEnding

PHPExcel_Writer_CSV::$_lineEnding = PHP_EOL

private

Definition at line 63 of file CSV.php.

Referenced by _writeLine(), and getLineEnding().

◆ $_phpExcel

PHPExcel_Writer_CSV::$_phpExcel

private

Definition at line 42 of file CSV.php.

◆ $_sheetIndex

PHPExcel_Writer_CSV::$_sheetIndex = 0

private

Definition at line 70 of file CSV.php.

Referenced by getSheetIndex().

◆ $_useBOM

PHPExcel_Writer_CSV::$_useBOM = false

private

Definition at line 77 of file CSV.php.

Referenced by getUseBOM().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _writeLine()

◆ getDelimiter()

◆ getEnclosure()

◆ getExcelCompatibility()

◆ getLineEnding()

◆ getSheetIndex()

◆ getUseBOM()

◆ save()

◆ setDelimiter()

◆ setEnclosure()

◆ setExcelCompatibility()

◆ setLineEnding()

◆ setSheetIndex()

◆ setUseBOM()

Field Documentation

◆ $_delimiter

◆ $_enclosure

◆ $_excelCompatibility

◆ $_lineEnding

◆ $_phpExcel

◆ $_sheetIndex

◆ $_useBOM