Initial xentral_oss_20.3.c9ffacf

classes/Components/Exporter/Csv/CsvExporter.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Xentral\Components\Exporter\Csv;
+
+use Iterator;
+use Xentral\Components\Exporter\Exception\FileExistsException;
+use Xentral\Components\Exporter\Exception\InvalidResourceException;
+
+final class CsvExporter
+{
+    /** @var CsvConfig $config */
+    private $config;
+
+    /**
+     * @param CsvConfig|null $config
+     */
+    public function __construct(CsvConfig $config = null)
+    {
+        if ($config === null) {
+            $config = new CsvConfig();
+        }
+
+        $this->config = $config;
+    }
+
+    /**
+     * @param string         $filePath Resource used for writing
+     * @param array|Iterator $data     Multi-dimentional array, Generator or Iterator
+     *
+     * @throws FileExistsException|InvalidResourceException
+     *
+     * @return void
+     */
+    public function export($filePath, $data)
+    {
+        $resource = $this->exportToResource($filePath, $data);
+        fclose($resource);
+    }
+
+    /**
+     * Same as ::export() beside that the created resource will be returned
+     *
+     * @param string         $filePath Resource used for writing
+     * @param array|Iterator $data     Multi-dimentional array, Generator or Iterator
+     *
+     * @throws FileExistsException|InvalidResourceException
+     *
+     * @return resource
+     */
+    public function exportToResource($filePath, $data)
+    {
+        if (is_file($filePath)) {
+            throw new FileExistsException(sprintf('File creation failed. File "%s" already exists.', $filePath));
+        }
+
+        // 'x+' = Create and open for reading and writing.
+        //        File pointer will be placed at the beginning of the file.
+        //        If the file already exists `fopen` will return false.
+        // 'b'  = Enable binary mode
+        $resource = @fopen($filePath, 'x+b');
+        if ($resource === false) {
+            throw new InvalidResourceException(sprintf('Failed to open resource for file path "%s".', $filePath));
+        }
+
+        $writer = new CsvWriter($resource, $this->config);
+        $writer->writeLines($data);
+
+        return $resource;
+    }
+}