Inheritance diagram for PhpOffice\PhpSpreadsheet\Writer\Csv:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Writer\Csv:

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...

	__construct (Spreadsheet $spreadsheet)
	IWriter constructor. More...

	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...

	save ($pFilename)
	Save PhpSpreadsheet to file. 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...

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

Detailed Description

Definition at line 8 of file Csv.php.

Constructor & Destructor Documentation

◆ __construct()

PhpOffice\PhpSpreadsheet\Writer\Csv::__construct ( Spreadsheet $spreadsheet )

Create a new CSV.

Parameters

Spreadsheet $spreadsheet Spreadsheet object

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 79 of file Csv.php.

    {
        $this->spreadsheet = $spreadsheet;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$spreadsheet.

Member Function Documentation

◆ getDelimiter()

PhpOffice\PhpSpreadsheet\Writer\Csv::getDelimiter ( )

Get delimiter.

Returns: string

Definition at line 142 of file Csv.php.

    {
        return $this->delimiter;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$delimiter.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().

Here is the caller graph for this function:

◆ getEnclosure()

PhpOffice\PhpSpreadsheet\Writer\Csv::getEnclosure ( )

Get enclosure.

Returns: string

Definition at line 166 of file Csv.php.

    {
        return $this->enclosure;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$enclosure.

◆ getEnclosureRequired()

PhpOffice\PhpSpreadsheet\Writer\Csv::getEnclosureRequired ( )

Definition at line 339 of file Csv.php.

                                          : bool
    {
        return $this->enclosureRequired;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$enclosureRequired.

◆ getExcelCompatibility()

PhpOffice\PhpSpreadsheet\Writer\Csv::getExcelCompatibility ( )

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

Returns: bool

Definition at line 262 of file Csv.php.

    {
        return $this->excelCompatibility;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$excelCompatibility.

◆ getIncludeSeparatorLine()

PhpOffice\PhpSpreadsheet\Writer\Csv::getIncludeSeparatorLine ( )

Get whether a separator line should be included.

Returns: bool

Definition at line 238 of file Csv.php.

    {
        return $this->includeSeparatorLine;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$includeSeparatorLine.

◆ getLineEnding()

PhpOffice\PhpSpreadsheet\Writer\Csv::getLineEnding ( )

Get line ending.

Returns: string

Definition at line 190 of file Csv.php.

    {
        return $this->lineEnding;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$lineEnding.

◆ getOutputEncoding()

PhpOffice\PhpSpreadsheet\Writer\Csv::getOutputEncoding ( )

Get output encoding.

Returns: string

Definition at line 311 of file Csv.php.

    {
        return $this->outputEncoding;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$outputEncoding.

◆ getSheetIndex()

PhpOffice\PhpSpreadsheet\Writer\Csv::getSheetIndex ( )

Get sheet index.

Returns: int

Definition at line 287 of file Csv.php.

    {
        return $this->sheetIndex;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$sheetIndex.

◆ getUseBOM()

PhpOffice\PhpSpreadsheet\Writer\Csv::getUseBOM ( )

Get whether BOM should be used.

Returns: bool

Definition at line 214 of file Csv.php.

    {
        return $this->useBOM;
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$useBOM.

◆ save()

PhpOffice\PhpSpreadsheet\Writer\Csv::save ( $pFilename )

Save PhpSpreadsheet to file.

Parameters

resource | string $pFilename

Implements PhpOffice\PhpSpreadsheet\Writer\IWriter.

Definition at line 89 of file Csv.php.

                                    : void
    {
        // Fetch sheet
        $sheet = $this->spreadsheet->getSheet($this->sheetIndex);
 
        $saveDebugLog = Calculation::getInstance($this->spreadsheet)->getDebugLog()->getWriteDebugLog();
        Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog(false);
        $saveArrayReturnType = Calculation::getArrayReturnType();
        Calculation::setArrayReturnType(Calculation::RETURN_ARRAY_AS_VALUE);
 
        // Open file
        $this->openFileHandle($pFilename);
 
        if ($this->excelCompatibility) {
            $this->setUseBOM(true); //  Enforce UTF-8 BOM Header
            $this->setIncludeSeparatorLine(true); //  Set separator line
            $this->setEnclosure('"'); //  Set enclosure to "
            $this->setDelimiter(';'); //  Set delimiter to a semi-colon
            $this->setLineEnding("\r\n");
        }
 
        if ($this->useBOM) {
            // Write the UTF-8 BOM code if required
            fwrite($this->fileHandle, "\xEF\xBB\xBF");
        }
 
        if ($this->includeSeparatorLine) {
            // Write the separator line if required
            fwrite($this->fileHandle, 'sep=' . $this->getDelimiter() . $this->lineEnding);
        }
 
        //    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($this->fileHandle, $cellsArray[0]);
        }
 
        $this->maybeCloseFileHandle();
        Calculation::setArrayReturnType($saveArrayReturnType);
        Calculation::getInstance($this->spreadsheet)->getDebugLog()->setWriteDebugLog($saveDebugLog);
    }

Here is the call graph for this function:

◆ setDelimiter()

PhpOffice\PhpSpreadsheet\Writer\Csv::setDelimiter ( $pValue )

Set delimiter.

Parameters

string $pValue Delimiter, defaults to ','

Returns: $this

Definition at line 154 of file Csv.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().

Here is the caller graph for this function:

◆ setEnclosure()

PhpOffice\PhpSpreadsheet\Writer\Csv::setEnclosure ( $pValue = '"' )

Set enclosure.

Parameters

string $pValue Enclosure, defaults to "

Returns: $this

Definition at line 178 of file Csv.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().

Here is the caller graph for this function:

◆ setEnclosureRequired()

PhpOffice\PhpSpreadsheet\Writer\Csv::setEnclosureRequired ( bool $value )

Definition at line 332 of file Csv.php.

                                                     : self
    {
        $this->enclosureRequired = $value;
 
        return $this;
    }

◆ setExcelCompatibility()

PhpOffice\PhpSpreadsheet\Writer\Csv::setExcelCompatibility ( $pValue )

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

Parameters

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

Returns: $this

Definition at line 275 of file Csv.php.

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

◆ setIncludeSeparatorLine()

PhpOffice\PhpSpreadsheet\Writer\Csv::setIncludeSeparatorLine ( $pValue )

Set whether a separator line should be included as the first line of the file.

Parameters

bool $pValue Use separator line? Defaults to false

Returns: $this

Definition at line 250 of file Csv.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().

Here is the caller graph for this function:

◆ setLineEnding()

PhpOffice\PhpSpreadsheet\Writer\Csv::setLineEnding ( $pValue )

Set line ending.

Parameters

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

Returns: $this

Definition at line 202 of file Csv.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().

Here is the caller graph for this function:

◆ setOutputEncoding()

PhpOffice\PhpSpreadsheet\Writer\Csv::setOutputEncoding ( $pValue )

Set output encoding.

Parameters

string $pValue Output encoding

Returns: $this

Definition at line 323 of file Csv.php.

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

◆ setSheetIndex()

PhpOffice\PhpSpreadsheet\Writer\Csv::setSheetIndex ( $pValue )

Set sheet index.

Parameters

int $pValue Sheet index

Returns: $this

Definition at line 299 of file Csv.php.

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

◆ setUseBOM()

PhpOffice\PhpSpreadsheet\Writer\Csv::setUseBOM ( $pValue )

Set whether BOM should be used.

Parameters

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

Returns: $this

Definition at line 226 of file Csv.php.

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

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().

Here is the caller graph for this function:

◆ writeLine()

PhpOffice\PhpSpreadsheet\Writer\Csv::writeLine	(		$pFileHandle,
		array	$pValues
	)

private

Write line to CSV file.

Parameters

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

Definition at line 350 of file Csv.php.

                                                            : void
    {
        // No leading delimiter
        $delimiter = '';
 
        // Build the line
        $line = '';
 
        foreach ($pValues as $element) {
            // Add delimiter
            $line .= $delimiter;
            $delimiter = $this->delimiter;
            // Escape enclosures
            $enclosure = $this->enclosure;
            if ($enclosure) {
                // If enclosure is not required, use enclosure only if
                // element contains newline, delimiter, or enclosure.
                if (!$this->enclosureRequired && strpbrk($element, "$delimiter$enclosure\n") === false) {
                    $enclosure = '';
                } else {
                    $element = str_replace($enclosure, $enclosure . $enclosure, $element);
                }
            }
            // Add enclosed string
            $line .= $enclosure . $element . $enclosure;
        }
 
        // Add line ending
        $line .= $this->lineEnding;
 
        // Write to file
        if ($this->outputEncoding != '') {
            $line = mb_convert_encoding($line, $this->outputEncoding);
        }
        fwrite($pFileHandle, $line);
    }

References PhpOffice\PhpSpreadsheet\Writer\Csv\$delimiter, PhpOffice\PhpSpreadsheet\Writer\Csv\$enclosure, and PhpOffice\PhpSpreadsheet\Writer\Csv\$lineEnding.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\save().

Here is the caller graph for this function:

Field Documentation

◆ $delimiter

PhpOffice\PhpSpreadsheet\Writer\Csv::$delimiter = ','

private

Definition at line 22 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getDelimiter(), and PhpOffice\PhpSpreadsheet\Writer\Csv\writeLine().

◆ $enclosure

PhpOffice\PhpSpreadsheet\Writer\Csv::$enclosure = '"'

private

Definition at line 29 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getEnclosure(), and PhpOffice\PhpSpreadsheet\Writer\Csv\writeLine().

◆ $enclosureRequired

PhpOffice\PhpSpreadsheet\Writer\Csv::$enclosureRequired = true

private

Definition at line 330 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getEnclosureRequired().

◆ $excelCompatibility

PhpOffice\PhpSpreadsheet\Writer\Csv::$excelCompatibility = false

private

Definition at line 65 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getExcelCompatibility().

◆ $includeSeparatorLine

PhpOffice\PhpSpreadsheet\Writer\Csv::$includeSeparatorLine = false

private

Definition at line 58 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getIncludeSeparatorLine().

◆ $lineEnding

PhpOffice\PhpSpreadsheet\Writer\Csv::$lineEnding = PHP_EOL

private

Definition at line 36 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getLineEnding(), and PhpOffice\PhpSpreadsheet\Writer\Csv\writeLine().

◆ $outputEncoding

PhpOffice\PhpSpreadsheet\Writer\Csv::$outputEncoding = ''

private

Definition at line 72 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getOutputEncoding().

◆ $sheetIndex

PhpOffice\PhpSpreadsheet\Writer\Csv::$sheetIndex = 0

private

Definition at line 43 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getSheetIndex().

◆ $spreadsheet

PhpOffice\PhpSpreadsheet\Writer\Csv::$spreadsheet

private

Definition at line 15 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\__construct().

◆ $useBOM

PhpOffice\PhpSpreadsheet\Writer\Csv::$useBOM = false

private

Definition at line 50 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Writer\Csv\getUseBOM().

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

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Writer/Csv.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDelimiter()

◆ getEnclosure()

◆ getEnclosureRequired()

◆ getExcelCompatibility()

◆ getIncludeSeparatorLine()

◆ getLineEnding()

◆ getOutputEncoding()

◆ getSheetIndex()

◆ getUseBOM()

◆ save()

◆ setDelimiter()

◆ setEnclosure()

◆ setEnclosureRequired()

◆ setExcelCompatibility()

◆ setIncludeSeparatorLine()

◆ setLineEnding()

◆ setOutputEncoding()

◆ setSheetIndex()

◆ setUseBOM()

◆ writeLine()

Field Documentation

◆ $delimiter

◆ $enclosure

◆ $enclosureRequired

◆ $excelCompatibility

◆ $includeSeparatorLine

◆ $lineEnding

◆ $outputEncoding

◆ $sheetIndex

◆ $spreadsheet

◆ $useBOM