ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
Public Member Functions | |
__construct (Spreadsheet $spreadsheet) | |
Create a new CSV. More... | |
save ($pFilename) | |
Save PhpSpreadsheet 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) | |
Set line ending. More... | |
getUseBOM () | |
Get whether BOM should be used. More... | |
setUseBOM ($pValue) | |
Set whether BOM should be used. More... | |
getIncludeSeparatorLine () | |
Get whether a separator line should be included. More... | |
setIncludeSeparatorLine ($pValue) | |
Set whether a separator line should be included as the first line of the file. More... | |
getExcelCompatibility () | |
Get whether the file should be saved with full Excel Compatibility. More... | |
setExcelCompatibility ($pValue) | |
Set whether the file should be saved with full Excel Compatibility. More... | |
getSheetIndex () | |
Get sheet index. More... | |
setSheetIndex ($pValue) | |
Set sheet index. More... | |
getOutputEncoding () | |
Get output encoding. More... | |
setOutputEncoding ($pValue) | |
Set output encoding. More... | |
setEnclosureRequired (bool $value) | |
getEnclosureRequired () | |
Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter | |
getIncludeCharts () | |
Write charts in workbook? If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object. More... | |
setIncludeCharts ($pValue) | |
Set write charts in workbook Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet 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) | |
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, $pDirectory=null) | |
Set use disk caching where possible? More... | |
getDiskCachingDirectory () | |
Get disk caching directory. More... | |
openFileHandle ($filename) | |
Open file handle. More... | |
Private Member Functions | |
writeLine ($pFileHandle, array $pValues) | |
Write line to CSV file. More... | |
Private Attributes | |
$spreadsheet | |
$delimiter = ',' | |
$enclosure = '"' | |
$lineEnding = PHP_EOL | |
$sheetIndex = 0 | |
$useBOM = false | |
$includeSeparatorLine = false | |
$excelCompatibility = false | |
$outputEncoding = '' | |
$enclosureRequired = true | |
Additional Inherited Members | |
Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter | |
maybeCloseFileHandle () | |
Close file handle only if we opened it ourselves. More... | |
Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Writer\BaseWriter | |
$includeCharts = false | |
$preCalculateFormulas = true | |
$fileHandle | |
PhpOffice\PhpSpreadsheet\Writer\Csv::__construct | ( | Spreadsheet | $spreadsheet | ) |
Create a new CSV.
Spreadsheet | $spreadsheet | Spreadsheet object |
Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.
Definition at line 79 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$spreadsheet.
PhpOffice\PhpSpreadsheet\Writer\Csv::getDelimiter | ( | ) |
Get delimiter.
Definition at line 142 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$delimiter.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().
PhpOffice\PhpSpreadsheet\Writer\Csv::getEnclosure | ( | ) |
Get enclosure.
Definition at line 166 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$enclosure.
PhpOffice\PhpSpreadsheet\Writer\Csv::getEnclosureRequired | ( | ) |
Definition at line 339 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$enclosureRequired.
PhpOffice\PhpSpreadsheet\Writer\Csv::getExcelCompatibility | ( | ) |
Get whether the file should be saved with full Excel Compatibility.
Definition at line 262 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$excelCompatibility.
PhpOffice\PhpSpreadsheet\Writer\Csv::getIncludeSeparatorLine | ( | ) |
Get whether a separator line should be included.
Definition at line 238 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$includeSeparatorLine.
PhpOffice\PhpSpreadsheet\Writer\Csv::getLineEnding | ( | ) |
Get line ending.
Definition at line 190 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$lineEnding.
PhpOffice\PhpSpreadsheet\Writer\Csv::getOutputEncoding | ( | ) |
Get output encoding.
Definition at line 311 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$outputEncoding.
PhpOffice\PhpSpreadsheet\Writer\Csv::getSheetIndex | ( | ) |
Get sheet index.
Definition at line 287 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$sheetIndex.
PhpOffice\PhpSpreadsheet\Writer\Csv::getUseBOM | ( | ) |
Get whether BOM should be used.
Definition at line 214 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$useBOM.
PhpOffice\PhpSpreadsheet\Writer\Csv::save | ( | $pFilename | ) |
Save PhpSpreadsheet to file.
resource | string | $pFilename |
Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.
Definition at line 89 of file Csv.php.
References $row, PhpOffice\PhpSpreadsheet\Calculation\Calculation\getArrayReturnType(), PhpOffice\PhpSpreadsheet\Writer\Csv\getDelimiter(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\getInstance(), PhpOffice\PhpSpreadsheet\Writer\BaseWriter\maybeCloseFileHandle(), PhpOffice\PhpSpreadsheet\Writer\BaseWriter\openFileHandle(), PhpOffice\PhpSpreadsheet\Calculation\Calculation\RETURN_ARRAY_AS_VALUE, PhpOffice\PhpSpreadsheet\Calculation\Calculation\setArrayReturnType(), PhpOffice\PhpSpreadsheet\Writer\Csv\setDelimiter(), PhpOffice\PhpSpreadsheet\Writer\Csv\setEnclosure(), PhpOffice\PhpSpreadsheet\Writer\Csv\setIncludeSeparatorLine(), PhpOffice\PhpSpreadsheet\Writer\Csv\setLineEnding(), PhpOffice\PhpSpreadsheet\Writer\Csv\setUseBOM(), and PhpOffice\PhpSpreadsheet\Writer\Csv\writeLine().
PhpOffice\PhpSpreadsheet\Writer\Csv::setDelimiter | ( | $pValue | ) |
Set delimiter.
string | $pValue | Delimiter, defaults to ',' |
Definition at line 154 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().
PhpOffice\PhpSpreadsheet\Writer\Csv::setEnclosure | ( | $pValue = '"' | ) |
Set enclosure.
string | $pValue | Enclosure, defaults to " |
Definition at line 178 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().
PhpOffice\PhpSpreadsheet\Writer\Csv::setEnclosureRequired | ( | bool | $value | ) |
PhpOffice\PhpSpreadsheet\Writer\Csv::setExcelCompatibility | ( | $pValue | ) |
Set whether the file should be saved with full Excel Compatibility.
bool | $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 |
PhpOffice\PhpSpreadsheet\Writer\Csv::setIncludeSeparatorLine | ( | $pValue | ) |
Set whether a separator line should be included as the first line of the file.
bool | $pValue | Use separator line? Defaults to false |
Definition at line 250 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().
PhpOffice\PhpSpreadsheet\Writer\Csv::setLineEnding | ( | $pValue | ) |
Set line ending.
string | $pValue | Line ending, defaults to OS line ending (PHP_EOL) |
Definition at line 202 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().
PhpOffice\PhpSpreadsheet\Writer\Csv::setOutputEncoding | ( | $pValue | ) |
PhpOffice\PhpSpreadsheet\Writer\Csv::setSheetIndex | ( | $pValue | ) |
PhpOffice\PhpSpreadsheet\Writer\Csv::setUseBOM | ( | $pValue | ) |
Set whether BOM should be used.
bool | $pValue | Use UTF-8 byte-order mark? Defaults to false |
Definition at line 226 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().
|
private |
Write line to CSV file.
resource | $pFileHandle | PHP filehandle |
array | $pValues | Array containing values in a row |
Definition at line 350 of file Csv.php.
References PhpOffice\PhpSpreadsheet\Writer\Csv\$delimiter, PhpOffice\PhpSpreadsheet\Writer\Csv\$enclosure, and PhpOffice\PhpSpreadsheet\Writer\Csv\$lineEnding.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().
|
private |
Definition at line 22 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getDelimiter(), and PhpOffice\PhpSpreadsheet\Writer\Csv\writeLine().
|
private |
Definition at line 29 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getEnclosure(), and PhpOffice\PhpSpreadsheet\Writer\Csv\writeLine().
|
private |
Definition at line 330 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getEnclosureRequired().
|
private |
Definition at line 65 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getExcelCompatibility().
|
private |
Definition at line 58 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getIncludeSeparatorLine().
|
private |
Definition at line 36 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getLineEnding(), and PhpOffice\PhpSpreadsheet\Writer\Csv\writeLine().
|
private |
Definition at line 72 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getOutputEncoding().
|
private |
Definition at line 43 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getSheetIndex().
|
private |
Definition at line 15 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\__construct().
|
private |
Definition at line 50 of file Csv.php.
Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getUseBOM().