Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_Writer_CSV
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_Writer_CSV

PHPExcel_Writer_CSV

PHPExcel_Writer_Abstract implements PHPExcel_Writer_IWriter
Extended by PHPExcel_Writer_CSV implements PHPExcel_Writer_IWriter
Package: PHPExcel\Writer\CSV
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Writer/CSV.php
Methods summary
public
# __construct( PHPExcel $phpExcel )

Create a new PHPExcel_Writer_CSV

Create a new PHPExcel_Writer_CSV

Parameters

$phpExcel
PHPExcel object
public
# save( string $pFilename = null )

Save PHPExcel to file

Save PHPExcel to file

Parameters

$pFilename

Throws

PHPExcel_Writer_Exception

Implementation of

PHPExcel_Writer_IWriter::save()
public string
# getDelimiter( )

Get delimiter

Get delimiter

Returns

string
public PHPExcel_Writer_CSV
# setDelimiter( string $pValue = ',' )

Set delimiter

Set delimiter

Parameters

$pValue
Delimiter, defaults to ,

Returns

PHPExcel_Writer_CSV
public string
# getEnclosure( )

Get enclosure

Get enclosure

Returns

string
public PHPExcel_Writer_CSV
# setEnclosure( string $pValue = '"' )

Set enclosure

Set enclosure

Parameters

$pValue
Enclosure, defaults to "

Returns

PHPExcel_Writer_CSV
public string
# getLineEnding( )

Get line ending

Get line ending

Returns

string
public PHPExcel_Writer_CSV
# setLineEnding( string $pValue = PHP_EOL )

Set line ending

Set line ending

Parameters

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

Returns

PHPExcel_Writer_CSV
public boolean
# getUseBOM( )

Get whether BOM should be used

Get whether BOM should be used

Returns

boolean
public PHPExcel_Writer_CSV
# setUseBOM( boolean $pValue = false )

Set whether BOM should be used

Set whether BOM should be used

Parameters

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

Returns

PHPExcel_Writer_CSV
public boolean
# getExcelCompatibility( )

Get whether the file should be saved with full Excel Compatibility

Get whether the file should be saved with full Excel Compatibility

Returns

boolean
public PHPExcel_Writer_CSV
# setExcelCompatibility( boolean $pValue = false )

Set whether the file should be saved with full Excel Compatibility

Set whether the file should be saved with full Excel Compatibility

Parameters

$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
public integer
# getSheetIndex( )

Get sheet index

Get sheet index

Returns

integer
public PHPExcel_Writer_CSV
# setSheetIndex( integer $pValue = 0 )

Set sheet index

Set sheet index

Parameters

$pValue
Sheet index

Returns

PHPExcel_Writer_CSV
private
# _writeLine( mixed $pFileHandle = null, array $pValues = null )

Write line to CSV file

Write line to CSV file

Parameters

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

Throws

PHPExcel_Writer_Exception
Methods inherited from PHPExcel_Writer_Abstract
getDiskCachingDirectory(), getIncludeCharts(), getPreCalculateFormulas(), getUseDiskCaching(), setIncludeCharts(), setPreCalculateFormulas(), setUseDiskCaching()
Properties summary
private PHPExcel $_phpExcel

PHPExcel object

PHPExcel object

#
private string $_delimiter

Delimiter

Delimiter

# ','
private string $_enclosure

Enclosure

Enclosure

# '"'
private string $_lineEnding

Line ending

Line ending

# PHP_EOL
private integer $_sheetIndex

Sheet index to write

Sheet index to write

# 0
private boolean $_useBOM

Whether to write a BOM (for UTF8).

Whether to write a BOM (for UTF8).

# false
private boolean $_excelCompatibility

Whether to write a fully Excel compatible CSV file.

Whether to write a fully Excel compatible CSV file.

# false
Properties inherited from PHPExcel_Writer_Abstract
$_diskCachingDirectory, $_includeCharts, $_preCalculateFormulas, $_useDiskCaching
Autene API documentation generated by ApiGen