CSV.php

Go to the documentation of this file.

<?php
class PHPExcel_Writer_CSV extends PHPExcel_Writer_Abstract implements PHPExcel_Writer_IWriter {
        private $_phpExcel;
 
        private $_delimiter     = ',';
 
        private $_enclosure     = '"';
 
        private $_lineEnding    = PHP_EOL;
 
        private $_sheetIndex    = 0;
 
        private $_useBOM = false;
 
        private $_excelCompatibility = false;
 
        public function __construct(PHPExcel $phpExcel) {
                $this->_phpExcel        = $phpExcel;
        }
 
        public function save($pFilename = null) {
                // 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);
        }
 
        public function getDelimiter() {
                return $this->_delimiter;
        }
 
        public function setDelimiter($pValue = ',') {
                $this->_delimiter = $pValue;
                return $this;
        }
 
        public function getEnclosure() {
                return $this->_enclosure;
        }
 
        public function setEnclosure($pValue = '"') {
                if ($pValue == '') {
                        $pValue = null;
                }
                $this->_enclosure = $pValue;
                return $this;
        }
 
        public function getLineEnding() {
                return $this->_lineEnding;
        }
 
        public function setLineEnding($pValue = PHP_EOL) {
                $this->_lineEnding = $pValue;
                return $this;
        }
 
        public function getUseBOM() {
                return $this->_useBOM;
        }
 
        public function setUseBOM($pValue = false) {
                $this->_useBOM = $pValue;
                return $this;
        }
 
        public function getExcelCompatibility() {
                return $this->_excelCompatibility;
        }
 
        public function setExcelCompatibility($pValue = false) {
                $this->_excelCompatibility = $pValue;
                return $this;
        }
 
        public function getSheetIndex() {
                return $this->_sheetIndex;
        }
 
        public function setSheetIndex($pValue = 0) {
                $this->_sheetIndex = $pValue;
                return $this;
        }
 
        private function _writeLine($pFileHandle = null, $pValues = null) {
                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.");
                }
        }
 
}