PHPExcel_Writer

# Class: PHPExcel_Writer_CSV Source Location: /PHPExcel/Writer/CSV.php
### Class Overview
PHPExcel_Writer_CSV #### Author(s): #### Copyright: Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel) Implements interfaces: PHPExcel_Writer_IWriter | ### Variables $_delimiter $_enclosure $_lineEnding $_phpExcel $_preCalculateFormulas $_sheetIndex $_useBOM | ### Methods __construct getDelimiter getEnclosure getLineEnding getPreCalculateFormulas getSheetIndex getUseBOM save setDelimiter setEnclosure setLineEnding setPreCalculateFormulas setSheetIndex setUseBOM _writeLine
### Class Details [line 57] PHPExcel_Writer_CSV PHPExcel_Writer_CSV #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### $_delimiter = [line 70] Delimiter Delimiter #### Tags:
access: | private
Type: | string
[ Top ] #### $_enclosure = [line 77] Enclosure Enclosure #### Tags:
access: | private
Type: | string
[ Top ] #### $_lineEnding = [line 84] Line ending Line ending #### Tags:
access: | private
Type: | string
[ Top ] #### $_phpExcel = [line 63] PHPExcel object PHPExcel object #### Tags:
access: | private
Type: | PHPExcel
[ Top ] #### $_preCalculateFormulas = true [line 98] Pre-calculate formulas Pre-calculate formulas #### Tags:
access: | private
Type: | boolean
[ Top ] #### $_sheetIndex = [line 91] Sheet index to write Sheet index to write #### Tags:
access: | private
Type: | int
[ Top ] #### $_useBOM = false [line 105] Whether to write a BOM (for UTF8). Whether to write a BOM (for UTF8). #### Tags:
access: | private
Type: | boolean
[ Top ] ### Class Methods ### constructor __construct [line 112]
`PHPExcel_Writer_CSV __construct( $phpExcel)`
Create a new PHPExcel_Writer_CSV Create a new PHPExcel_Writer_CSV #### Tags:
access: | public
#### Parameters:
PHPExcel | $phpExcel | PHPExcel object
[ Top ] ### method getDelimiter [line 163]
`string getDelimiter( )`
Get delimiter Get delimiter #### Tags:
access: | public
[ Top ] ### method getEnclosure [line 183]
`string getEnclosure( )`
Get enclosure Get enclosure #### Tags:
access: | public
[ Top ] ### method getLineEnding [line 206]
`string getLineEnding( )`
Get line ending Get line ending #### Tags:
access: | public
[ Top ] ### method getPreCalculateFormulas [line 306]
`boolean getPreCalculateFormulas( )`
Get Pre-Calculate Formulas Get Pre-Calculate Formulas #### Tags:
access: | public
[ Top ] ### method getSheetIndex [line 246]
`int getSheetIndex( )`
Get sheet index Get sheet index #### Tags:
access: | public
[ Top ] ### method getUseBOM [line 226]
`boolean getUseBOM( )`
Get whether BOM should be used Get whether BOM should be used #### Tags:
access: | public
[ Top ] ### method save [line 126]
`void save( [ $pFilename = null], string $pFileName)`
Save PHPExcel to file Save PHPExcel to file #### Tags:
throws: | Exception
access: | public
Implementation of: PHPExcel_Writer_IWriter::save() Save PHPExcel to file #### Parameters:
string | $pFileName |
| $pFilename |
[ Top ] ### method setDelimiter [line 173]
`PHPExcel_Writer_CSV setDelimiter( [string $pValue = ','])`
Set delimiter Set delimiter #### Tags:
access: | public
#### Parameters:
string | $pValue | Delimiter, defaults to ,
[ Top ] ### method setEnclosure [line 193]
`PHPExcel_Writer_CSV setEnclosure( [string $pValue = '"'])`
Set enclosure Set enclosure #### Tags:
access: | public
#### Parameters:
string | $pValue | Enclosure, defaults to "
[ Top ] ### method setLineEnding [line 216]
`PHPExcel_Writer_CSV setLineEnding( [string $pValue = PHP_EOL])`
Set line ending Set line ending #### Tags:
access: | public
#### Parameters:
string | $pValue | Line ending, defaults to OS line ending (PHP_EOL)
[ Top ] ### method setPreCalculateFormulas [line 316]
`PHPExcel_Writer_CSV setPreCalculateFormulas( [boolean $pValue = true])`
Set Pre-Calculate Formulas Set Pre-Calculate Formulas #### Tags:
access: | public
#### Parameters:
boolean | $pValue | Pre-Calculate Formulas?
[ Top ] ### method setSheetIndex [line 256]
`PHPExcel_Writer_CSV setSheetIndex( [int $pValue = 0])`
Set sheet index Set sheet index #### Tags:
access: | public
#### Parameters:
int | $pValue | Sheet index
[ Top ] ### method setUseBOM [line 236]
`PHPExcel_Writer_CSV setUseBOM( [boolean $pValue = false])`
Set whether BOM should be used Set whether BOM should be used #### Tags:
access: | public
#### Parameters:
boolean | $pValue | Use UTF-8 byte-order mark? Defaults to false
[ Top ] ### method _writeLine [line 268]
`void _writeLine( [mixed $pFileHandle = null], [array $pValues = null])`
Write line to CSV file Write line to CSV file #### Tags:
throws: | Exception
access: | private
#### Parameters:
mixed | $pFileHandle | PHP filehandle
array | $pValues | Array containing values in a row
[ Top ] Documentation generated on Mon, 11 Jan 2010 08:07:35 +0100 by phpDocumentor 1.4.1