framework/main/classes/file_directories/text/input/csv/class_CsvInputFile.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem\Input\Csv;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filesystem\Text\BaseInputTextFile;
   7 use Org\Mxchange\CoreFramework\Stream\Filesystem\CsvInputStreamer;
   8
   9 // Import SPL stuff
  10 use \SplFileInfo;
  11
  12 /**
  13  * A CSV file input class for writing CSV files
  14  *
  15  * @author              Roland Haeder <webmaster@ship-simu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.ship-simu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 class CsvInputFile extends BaseInputTextFile implements CsvInputStreamer {
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this File class and prepares it for usage
  47          *
  48          * @param       $infoInstance   An instance of a SplFileInfo class
  49          * @return      $fileInstance   An instance of this File class
  50          */
  51         public final static function createCsvInputFile (SplFileInfo $infoInstance) {
  52                 // Get a new instance
  53                 $fileInstance = new CsvInputFile();
  54
  55                 // Init this abstract file
  56                 $fileInstance->initFile($infoInstance);
  57
  58                 // Return the prepared instance
  59                 return $fileInstance;
  60         }
  61
  62         /**
  63          * Reads a line from CSV file and returns it as an indexed array. Please
  64          * note that strings *must* be always in double-quotes, else any found
  65          * column separators will be parsed or they may be interpreted incorrectly.
  66          *
  67          * @param       $columnSeparator        Character to use separting columns
  68          * @return      $lineArray                      An indexed array with the read line
  69          */
  70         public function readCsvFileLine ($columnSeparator) {
  71                 // Debug message
  72                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] columnSeparator=%s - CALLED!', __METHOD__, __LINE__, $columnSeparator));
  73
  74                 // Read raw line
  75                 $data = $this->getPointerInstance()->readLine();
  76
  77                 // Debug message
  78                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] data()=%d', __METHOD__, __LINE__, strlen($data)));
  79
  80                 // Parse data
  81                 $lineArray = $this->parseDataToIndexedArray($data, $columnSeparator);
  82
  83                 // Debug message
  84                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] lineArray()=%d - EXIT!', __METHOD__, __LINE__, count($lineArray)));
  85
  86                 // Return it
  87                 return $lineArray;
  88         }
  89
  90         /**
  91          * Parses given data into an array
  92          *
  93          * @param       $data                           Raw data e.g. returned from readLine()
  94          * @param       $columnSeparator        Character to use separting columns
  95          * @return      $lineArray                      An indexed array with the read line
  96          */
  97         private function parseDataToIndexedArray ($data, $columnSeparator) {
  98                 // Debug message
  99                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] data()=%d,columnSeparator=%s - CALLED!', __METHOD__, __LINE__, strlen($data), $columnSeparator));
 100
 101                 // Init return array
 102                 $lineArray = array();
 103
 104                 // Whether the parser reads a quoted string (which may contain the column separator again)
 105                 $isInQuotes = false;
 106
 107                 // Init column data
 108                 $column = '';
 109
 110                 // Now parse the line
 111                 for ($idx = 0; $idx < strlen($data); $idx++) {
 112                         // "Cache" char
 113                         $char = substr($data, $idx, 1);
 114
 115                         // Debug message
 116                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] idx=%s,char=%s ...', __METHOD__, __LINE__, $idx, $char));
 117
 118                         // Is the column separator found and not within quotes?
 119                         if (($isInQuotes === false) && ($char == $columnSeparator)) {
 120                                 // Debug message
 121                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] Adding column=%s ...', __METHOD__, __LINE__, $column));
 122
 123                                 // Add this line to the array
 124                                 array_push($lineArray, $column);
 125
 126                                 // Debug message
 127                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] lineArray()=%d - After add!', __METHOD__, __LINE__, count($lineArray)));
 128
 129                                 // Clear variable ...
 130                                 $column = '';
 131
 132                                 // ... and skip it
 133                                 continue;
 134                         } elseif ($char == chr(34)) {
 135                                 // Debug message
 136                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] column=%s ...', __METHOD__, __LINE__, $column));
 137
 138                                 // $column must be empty at this point if we are at starting quote
 139                                 assert(($isInQuotes === true) || (empty($column)));
 140
 141                                 // Double-quote found, so flip variable
 142                                 $isInQuotes = (!$isInQuotes);
 143
 144                                 // Debug message
 145                                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] isInQuotes=%d ...', __METHOD__, __LINE__, intval($isInQuotes)));
 146
 147                                 // Skip double-quote (escaping of them is not yet supported)
 148                                 continue;
 149                         }
 150
 151                         // Debug message
 152                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] Adding char=%s ...', __METHOD__, __LINE__, $idx, $char));
 153
 154                         // Add char to column
 155                         $column .= $char;
 156                 } // END - for
 157
 158                 // Is there something outstanding?
 159                 if (!empty($column)) {
 160                         // Debug message
 161                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] Adding column=%s ...', __METHOD__, __LINE__, $column));
 162
 163                         // Then don't forget this. :-)
 164                         array_push($lineArray, $column);
 165
 166                         // Debug message
 167                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] lineArray()=%d - After add!', __METHOD__, __LINE__, count($lineArray)));
 168                 } // END - if
 169
 170                 // Debug message
 171                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] lineArray()=%d - EXIT!', __METHOD__, __LINE__, count($lineArray)));
 172
 173                 // Return it
 174                 return $lineArray;
 175         }
 176
 177 }
 178