Refactor - split into Reader and Writer classes

src/AbstractCsvFile.php

@@ -0,0 +1,105 @@
+<?php
+
+namespace Keboola\Csv;
+
+use SplFileInfo;
+
+class AbstractCsvFile extends SplFileInfo
+{
+    const DEFAULT_DELIMITER = ',';
+    const DEFAULT_ENCLOSURE = '"';
+
+    /**
+     * @var string
+     */
+    protected $delimiter;
+
+    /**
+     * @var string
+     */
+    protected $enclosure;
+
+    /**
+     * @var string
+     */
+    protected $lineBreak;
+
+    /**
+     * @param string $delimiter
+     * @throws InvalidArgumentException
+     */
+    protected function setDelimiter($delimiter)
+    {
+        $this->validateDelimiter($delimiter);
+        $this->delimiter = $delimiter;
+    }
+
+    /**
+     * @param string $delimiter
+     * @throws InvalidArgumentException
+     */
+    protected function validateDelimiter($delimiter)
+    {
+        if (strlen($delimiter) > 1) {
+            throw new InvalidArgumentException(
+                "Delimiter must be a single character. \"$delimiter\" received",
+                Exception::INVALID_PARAM,
+                null,
+                Exception::INVALID_PARAM_STR
+            );
+        }
+
+        if (strlen($delimiter) == 0) {
+            throw new InvalidArgumentException(
+                "Delimiter cannot be empty.",
+                Exception::INVALID_PARAM,
+                null,
+                Exception::INVALID_PARAM_STR
+            );
+        }
+    }
+
+    /**
+     * @param string $enclosure
+     * @return $this
+     * @throws InvalidArgumentException
+     */
+    protected function setEnclosure($enclosure)
+    {
+        $this->validateEnclosure($enclosure);
+        $this->enclosure = $enclosure;
+        return $this;
+    }
+
+    /**
+     * @param string $enclosure
+     * @throws InvalidArgumentException
+     */
+    protected function validateEnclosure($enclosure)
+    {
+        if (strlen($enclosure) > 1) {
+            throw new InvalidArgumentException(
+                "Enclosure must be a single character. \"$enclosure\" received",
+                Exception::INVALID_PARAM,
+                null,
+                Exception::INVALID_PARAM_STR
+            );
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getDelimiter()
+    {
+        return $this->delimiter;
+    }
+
+    /**
+     * @return string
+     */
+    public function getEnclosure()
+    {
+        return $this->enclosure;
+    }
+}

src/CsvFile.php → src/CsvReader.php

@@ -2,22 +2,10 @@
 
 namespace Keboola\Csv;
 
-class CsvFile extends \SplFileInfo implements \Iterator
+class CsvReader extends AbstractCsvFile implements \Iterator
 {
-    const DEFAULT_DELIMITER = ',';
-    const DEFAULT_ENCLOSURE = '"';
     const DEFAULT_ESCAPED_BY = "";
 
-    /**
-     * @var string
-     */
-    protected $delimiter;
-
-    /**
-     * @var string
-     */
-    protected $enclosure;
-
     /**
      * @var string
      */
@@ -44,9 +32,9 @@ class CsvFile extends \SplFileInfo implements \Iterator
     protected $currentRow;
 
     /**
-     * @var string
+     * @var array
      */
-    protected $lineBreak;
+    protected $header;
 
     /**
      * CsvFile constructor.
@@ -70,6 +58,7 @@ public function __construct(
         $this->setDelimiter($delimiter);
         $this->setEnclosure($enclosure);
         $this->setSkipLines($skipLines);
+        $this->openCsvFile();
     }
 
     public function __destruct()
@@ -79,7 +68,7 @@ public function __destruct()
 
     /**
      * @param integer $skipLines
-     * @return CsvFile
+     * @return CsvReader
      * @throws InvalidArgumentException
      */
     protected function setSkipLines($skipLines)
@@ -105,71 +94,6 @@ protected function validateSkipLines($skipLines)
         }
     }
 
-    /**
-     * @param string $delimiter
-     * @return CsvFile
-     * @throws InvalidArgumentException
-     */
-    protected function setDelimiter($delimiter)
-    {
-        $this->validateDelimiter($delimiter);
-        $this->delimiter = $delimiter;
-        return $this;
-    }
-
-    /**
-     * @param string $delimiter
-     * @throws InvalidArgumentException
-     */
-    protected function validateDelimiter($delimiter)
-    {
-        if (strlen($delimiter) > 1) {
-            throw new InvalidArgumentException(
-                "Delimiter must be a single character. \"$delimiter\" received",
-                Exception::INVALID_PARAM,
-                null,
-                Exception::INVALID_PARAM_STR
-            );
-        }
-
-        if (strlen($delimiter) == 0) {
-            throw new InvalidArgumentException(
-                "Delimiter cannot be empty.",
-                Exception::INVALID_PARAM,
-                null,
-                Exception::INVALID_PARAM_STR
-            );
-        }
-    }
-
-    /**
-     * @param string $enclosure
-     * @return $this
-     * @throws InvalidArgumentException
-     */
-    protected function setEnclosure($enclosure)
-    {
-        $this->validateEnclosure($enclosure);
-        $this->enclosure = $enclosure;
-        return $this;
-    }
-
-    /**
-     * @param string $enclosure
-     * @throws InvalidArgumentException
-     */
-    protected function validateEnclosure($enclosure)
-    {
-        if (strlen($enclosure) > 1) {
-            throw new InvalidArgumentException(
-                "Enclosure must be a single character. \"$enclosure\" received",
-                Exception::INVALID_PARAM,
-                null,
-                Exception::INVALID_PARAM_STR
-            );
-        }
-    }
-
     /**
      * @return string
      * @throws Exception
@@ -178,7 +102,6 @@ protected function detectLineBreak()
     {
         rewind($this->getFilePointer());
         $sample = fread($this->getFilePointer(), 10000);
-        rewind($this->getFilePointer());
 
         $possibleLineBreaks = [
             "\r\n", // win
@@ -218,33 +141,27 @@ protected function readLine()
     }
 
     /**
-     * @param string $mode
      * @return resource
-     * @throws Exception
      */
-    protected function getFilePointer($mode = 'r')
+    protected function getFilePointer()
     {
-        if (!is_resource($this->filePointer)) {
-            $this->openCsvFile($mode);
-        }
         return $this->filePointer;
     }
 
     /**
-     * @param string $mode
      * @throws Exception
      */
-    protected function openCsvFile($mode)
+    protected function openCsvFile()
     {
-        if ($mode == 'r' && !is_file($this->getPathname())) {
+        if (!is_file($this->getPathname())) {
             throw new Exception(
                 "Cannot open file {$this->getPathname()}",
                 Exception::FILE_NOT_EXISTS,
                 null,
                 Exception::FILE_NOT_EXISTS_STR
             );
         }
-        $this->filePointer = @fopen($this->getPathname(), $mode);
+        $this->filePointer = @fopen($this->getPathname(), "r");
         if (!$this->filePointer) {
             throw new Exception(
                 "Cannot open file {$this->getPathname()} " . error_get_last()['message'],
@@ -253,6 +170,10 @@ protected function openCsvFile($mode)
                 Exception::FILE_NOT_EXISTS_STR
             );
         }
+        $this->lineBreak = $this->detectLineBreak();
+        rewind($this->getFilePointer());
+        $this->header = $this->readLine();
+        $this->rewind();
     }
 
     protected function closeFile()
@@ -262,22 +183,6 @@ protected function closeFile()
         }
     }
 
-    /**
-     * @return string
-     */
-    public function getDelimiter()
-    {
-        return $this->delimiter;
-    }
-
-    /**
-     * @return string
-     */
-    public function getEnclosure()
-    {
-        return $this->enclosure;
-    }
-
     /**
      * @return string
      */
@@ -299,81 +204,18 @@ public function getColumnsCount()
      */
     public function getHeader()
     {
-        $this->rewind();
-        $current = $this->current();
-        if (is_array($current)) {
-            return $current;
+        if ($this->header) {
+            return $this->header;
         }
-
         return [];
     }
 
-    /**
-     * @param array $row
-     * @throws Exception
-     */
-    public function writeRow(array $row)
-    {
-        $str = $this->rowToStr($row);
-        $ret = fwrite($this->getFilePointer('w+'), $str);
-
-        /* According to http://php.net/fwrite the fwrite() function
-         should return false on error. However not writing the full
-         string (which may occur e.g. when disk is full) is not considered
-         as an error. Therefore both conditions are necessary. */
-        if (($ret === false) || (($ret === 0) && (strlen($str) > 0))) {
-            throw new Exception(
-                "Cannot write to file {$this->getPathname()}",
-                Exception::WRITE_ERROR,
-                null,
-                Exception::WRITE_ERROR_STR
-            );
-        }
-    }
-
-    /**
-     * @param array $row
-     * @return string
-     * @throws Exception
-     */
-    public function rowToStr(array $row)
-    {
-        $return = [];
-        foreach ($row as $column) {
-            if (!(
-                is_scalar($column)
-                || is_null($column)
-                || (
-                    is_object($column)
-                    && method_exists($column, '__toString')
-                )
-            )) {
-                $type = gettype($column);
-                throw new Exception(
-                    "Cannot write {$type} into a column",
-                    Exception::WRITE_ERROR,
-                    null,
-                    Exception::WRITE_ERROR_STR,
-                    ['column' => $column]
-                );
-            }
-
-            $return[] = $this->getEnclosure() .
-                str_replace($this->getEnclosure(), str_repeat($this->getEnclosure(), 2), $column) .
-                $this->getEnclosure();
-        }
-        return implode($this->getDelimiter(), $return) . "\n";
-    }
-
     /**
      * @return string
      * @throws Exception
      */
     public function getLineBreak()
     {
-        if (!$this->lineBreak) {
-            $this->lineBreak = $this->detectLineBreak();
-        }
         return $this->lineBreak;
     }