From cb8ba1d2a4f48b819eeb130c6b7f73d1d03ab48f Mon Sep 17 00:00:00 2001 From: madflow Date: Sun, 30 Jul 2017 17:26:58 +0200 Subject: [PATCH] remove *withStyle methods from interface, docs cleanup --- src/Spout/Writer/WriterInterface.php | 63 +++++++--------------------- 1 file changed, 14 insertions(+), 49 deletions(-) diff --git a/src/Spout/Writer/WriterInterface.php b/src/Spout/Writer/WriterInterface.php index 4b8c6c6..00030c0 100644 --- a/src/Spout/Writer/WriterInterface.php +++ b/src/Spout/Writer/WriterInterface.php @@ -2,7 +2,8 @@ namespace Box\Spout\Writer; -use Box\Spout\Writer\Common\Entity\Style\Style; +use Box\Spout\Common\Exception\IOException; +use Box\Spout\Writer\Common\Entity\Row; /** * Interface WriterInterface @@ -12,88 +13,52 @@ use Box\Spout\Writer\Common\Entity\Style\Style; interface WriterInterface { /** - * Inits the writer and opens it to accept data. + * Initializes 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 WriterInterface - * @throws \Box\Spout\Common\Exception\IOException If the writer cannot be opened or if the given path is not writable + * @throws 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. + * Initializes 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 + * @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 WriterInterface - * @throws \Box\Spout\Common\Exception\IOException If the writer cannot be opened + * @throws 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. + * Append a row to the end of the stream. * - * @param array|\Box\Spout\Writer\Common\Entity\Row $row The row to be appended to the stream + * @param Row $row The row to be appended to the stream * @return WriterInterface - * @internal param array $row Array containing data to be streamed. - * Example $row= ['data1', 1234, null, '', 'data5']; - * @internal param \Box\Spout\Writer\Common\Entity\Row $row A Row object with cells and styles - * Example $row = (new Row())->addCell('data1'); */ public function addRow($row); /** - * Write given data to the output and apply the given style. - * @see addRow - * - * @param array|\Box\Spout\Writer\Common\Entity\Row $row The row to be appended to the stream - * @param Style $style Style to be applied to the row. - * @return WriterInterface - * @internal param array $row Array containing data to be streamed. - * Example $row= ['data1', 1234, null, '', 'data5']; - * @internal param \Box\Spout\Writer\Common\Entity\Row $row A Row object with cells and styles - * Example $row = (new Row())->addCell('data1'); - */ - public function addRowWithStyle($row, $style); - - /** - * Write given data to the output with a closure funtion. New data will be appended to end of stream. + * Write given data to the output with a closure function. New data will be appended to the end of the stream. * * @param \Closure $callback A callback returning a Row object. A new Row object is injected into the callback. * @return WriterInterface - * @internal param \Closure $callback - * Example withRow(function(Row $row) { return $row->addCell('data1'); }) */ public function withRow(\Closure $callback); /** - * Write given data to the output. New data will be appended to end of stream. + * Write a given array of rows to the output. New data will be appended to the end of the stream. * - * @param array $dataRows Array of array containing data to be streamed. - * Example $dataRow = [ - * ['data11', 12, , '', 'data13'], - * ['data21', 'data22', null], - * ]; + * @param Row[] $rows Array of rows be appended to the stream * @return 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); - - /** - * Write given data to the output and apply the given style. - * @see addRows - * - * @param array $dataRows Array of array containing data to be streamed. - * @param Style $style Style to be applied to the rows. - * @return WriterInterface - * @throws \Box\Spout\Common\Exception\InvalidArgumentException If the input param is not valid - * @throws \Box\Spout\Writer\Exception\WriterNotOpenedException If this function is called before opening the writer - * @throws \Box\Spout\Common\Exception\IOException If unable to write data - */ - public function addRowsWithStyle(array $dataRows, $style); + public function addRows(array $rows); /** * Closes the writer. This will close the streamer as well, preventing new data