CSV.php

Go to the documentation of this file.

<?php
if (!defined('PHPEXCEL_ROOT')) {
        define('PHPEXCEL_ROOT', dirname(__FILE__) . '/../../');
        require(PHPEXCEL_ROOT . 'PHPExcel/Autoloader.php');
}

class PHPExcel_Reader_CSV implements PHPExcel_Reader_IReader
{
        private $_inputEncoding = 'UTF-8';

        private $_delimiter             = ',';

        private $_enclosure             = '"';

        private $_lineEnding    = PHP_EOL;

        private $_sheetIndex    = 0;

        private $_contiguous    = false;


        private $_contiguousRow = -1;

        private $_readFilter = null;

        public function __construct() {
                $this->_readFilter              = new PHPExcel_Reader_DefaultReadFilter();
        }       //      function __construct()

        public function canRead($pFilename)
        {
                // Check if file exists
                if (!file_exists($pFilename)) {
                        throw new Exception("Could not open " . $pFilename . " for reading! File does not exist.");
                }

                return true;
        }       //      function canRead()

        public function load($pFilename)
        {
                // Create new PHPExcel
                $objPHPExcel = new PHPExcel();

                // Load into this instance
                return $this->loadIntoExisting($pFilename, $objPHPExcel);
        }       //      function load()

        public function getReadFilter() {
                return $this->_readFilter;
        }       //      function getReadFilter()

        public function setReadFilter(PHPExcel_Reader_IReadFilter $pValue) {
                $this->_readFilter = $pValue;
                return $this;
        }       //      function setReadFilter()

        public function setInputEncoding($pValue = 'UTF-8')
        {
                $this->_inputEncoding = $pValue;
                return $this;
        }       //      function setInputEncoding()

        public function getInputEncoding()
        {
                return $this->_inputEncoding;
        }       //      function getInputEncoding()

        public function loadIntoExisting($pFilename, PHPExcel $objPHPExcel)
        {
                // Check if file exists
                if (!file_exists($pFilename)) {
                        throw new Exception("Could not open " . $pFilename . " for reading! File does not exist.");
                }

                // Create new PHPExcel
                while ($objPHPExcel->getSheetCount() <= $this->_sheetIndex) {
                        $objPHPExcel->createSheet();
                }
                $objPHPExcel->setActiveSheetIndex( $this->_sheetIndex );

                // Open file
                $fileHandle = fopen($pFilename, 'r');
                if ($fileHandle === false) {
                        throw new Exception("Could not open file $pFilename for reading.");
                }

                // Skip BOM, if any
                switch ($this->_inputEncoding) {
                        case 'UTF-8':
                                fgets($fileHandle, 4) == "\xEF\xBB\xBF" ?
                                        fseek($fileHandle, 3) : fseek($fileHandle, 0);
                                break;
                        case 'UTF-16LE':
                                fgets($fileHandle, 3) == "\xFF\xFE" ?
                                        fseek($fileHandle, 2) : fseek($fileHandle, 0);
                                break;
                        case 'UTF-16BE':
                                fgets($fileHandle, 3) == "\xFE\xFF" ?
                                        fseek($fileHandle, 2) : fseek($fileHandle, 0);
                                break;
                        case 'UTF-32LE':
                                fgets($fileHandle, 5) == "\xFF\xFE\x00\x00" ?
                                        fseek($fileHandle, 4) : fseek($fileHandle, 0);
                                break;
                        case 'UTF-32BE':
                                fgets($fileHandle, 5) == "\x00\x00\xFE\xFF" ?
                                        fseek($fileHandle, 4) : fseek($fileHandle, 0);
                                break;
                        default:
                                break;
                }

                $escapeEnclosures = array( "\\" . $this->_enclosure,
                                                                   $this->_enclosure . $this->_enclosure
                                                                 );

                // Set our starting row based on whether we're in contiguous mode or not
                $currentRow = 1;
                if ($this->_contiguous) {
                        $currentRow = ($this->_contiguousRow == -1) ? $objPHPExcel->getActiveSheet()->getHighestRow(): $this->_contiguousRow;
                }

                // Loop through each line of the file in turn
                while (($rowData = fgetcsv($fileHandle, 0, $this->_delimiter, $this->_enclosure)) !== FALSE) {
                        $columnLetter = 'A';
                        foreach($rowData as $rowDatum) {
                                if ($rowDatum != '' && $this->_readFilter->readCell($columnLetter, $currentRow)) {
                                        // Unescape enclosures
                                        $rowDatum = str_replace($escapeEnclosures, $this->_enclosure, $rowDatum);

                                        // Convert encoding if necessary
                                        if ($this->_inputEncoding !== 'UTF-8') {
                                                $rowDatum = PHPExcel_Shared_String::ConvertEncoding($rowDatum, 'UTF-8', $this->_inputEncoding);
                                        }

                                        // Set cell value
                                        $objPHPExcel->getActiveSheet()->getCell($columnLetter . $currentRow)->setValue($rowDatum);
                                }
                                ++$columnLetter;
                        }
                        ++$currentRow;
                }

                // Close file
                fclose($fileHandle);

                if ($this->_contiguous) {
                        $this->_contiguousRow = $currentRow;
                }

                // Return
                return $objPHPExcel;
        }       //      function loadIntoExisting()

        public function getDelimiter() {
                return $this->_delimiter;
        }       //      function getDelimiter()

        public function setDelimiter($pValue = ',') {
                $this->_delimiter = $pValue;
                return $this;
        }       //      function setDelimiter()

        public function getEnclosure() {
                return $this->_enclosure;
        }       //      function getEnclosure()

        public function setEnclosure($pValue = '"') {
                if ($pValue == '') {
                        $pValue = '"';
                }
                $this->_enclosure = $pValue;
                return $this;
        }       //      function setEnclosure()

        public function getLineEnding() {
                return $this->_lineEnding;
        }       //      function getLineEnding()

        public function setLineEnding($pValue = PHP_EOL) {
                $this->_lineEnding = $pValue;
                return $this;
        }       //      function setLineEnding()

        public function getSheetIndex() {
                return $this->_sheetIndex;
        }       //      function getSheetIndex()

        public function setSheetIndex($pValue = 0) {
                $this->_sheetIndex = $pValue;
                return $this;
        }       //      function setSheetIndex()

        public function setContiguous($contiguous = false)
        {
                $this->_contiguous = (bool)$contiguous;
                if (!$contiguous) {
                        $this->_contiguousRow   = -1;
                }

                return $this;
        }       //      function setInputEncoding()

        public function getContiguous() {
                return $this->_contiguous;
        }       //      function getSheetIndex()

}