First external release

src/Spout/Writer/WriterInterface.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Box\Spout\Writer;
+
+/**
+ * Interface WriterInterface
+ *
+ * @package Box\Spout\Writer
+ */
+interface WriterInterface
+{
+    /**
+     * Inits the writer and opens it to accept data.
+     * By using this method, the data will be written to a file.
+     *
+     * @param  string $outputFilePath Path of the output file that will contain the data
+     * @return \Box\Spout\Writer\WriterInterface
+     * @throws \Box\Spout\Common\Exception\IOException If the writer cannot be opened or if the given path is not writable
+     */
+    public function openToFile($outputFilePath);
+
+    /**
+     * Inits the writer and opens it to accept data.
+     * By using this method, the data will be outputted directly to the browser.
+     *
+     * @param  string $outputFileName Name of the output file that will contain the data. If a path is passed in, only the file name will be kept
+     * @return \Box\Spout\Writer\WriterInterface
+     * @throws \Box\Spout\Common\Exception\IOException If the writer cannot be opened
+     */
+    public function openToBrowser($outputFileName);
+
+    /**
+     * Write given data to the output. New data will be appended to end of stream.
+     *
+     * @param  array $dataRow Array containing data to be streamed.
+     *          Example $dataRow = ['data1', 1234, null, '', 'data5'];
+     * @return \Box\Spout\Writer\WriterInterface
+     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yetthe writer
+     * @throws \Box\Spout\Common\Exception\IOException If unable to write data
+     */
+    public function addRow(array $dataRow);
+
+    /**
+     * Write given data to the output. New data will be appended to end of stream.
+     *
+     * @param  array $dataRows Array of array containing data to be streamed.
+     *          Example $dataRow = [
+     *              ['data11', 12, , '', 'data13'],
+     *              ['data21', 'data22', null],
+     *          ];
+     * @return \Box\Spout\Writer\WriterInterface
+     * @throws \Box\Spout\Common\Exception\InvalidArgumentException If the input param is not valid
+     * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If the writer has not been opened yet
+     * @throws \Box\Spout\Common\Exception\IOException If unable to write data
+     */
+    public function addRows(array $dataRows);
+
+    /**
+     * Closes the writer. This will close the streamer as well, preventing new data
+     * to be written to the file.
+     *
+     * @return void
+     */
+    public function close();
+}