ronrademaker/exporter

Library to export data in various input formats to various output formats.

Exporter

Library to export data in various input formats to various output formats., _(*1)

, _(*2)

Installation

``` bash composer require ronrademaker/exporter, <sub>(*3)</sub>

# Usage

## Output an array to CSV in a file

``` php
$someArray = [
  ['foo' => 'foo', 'bar' => 'bar'],
  ['foo' => 'foobar', 'bar' => 'baz'],
  ['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'],
  ['foo' => 'bar', 'baz' => 'bar'],
  ['foo' => 'baz', 'bar' => 'foobar'],
];

$data = new ArrayData($someArray);
$fileOption = new FileOption($outputFile);
$exporter = new CSVExporter();
$exporter->export($data, [$fileOption]);

or, <sub>(*4)</sub>

``` php $someArray = [ ['foo' => 'foo', 'bar' => 'bar'], ['foo' => 'foobar', 'bar' => 'baz'], ['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'], ['foo' => 'bar', 'baz' => 'bar'], ['foo' => 'baz', 'bar' => 'foobar'], ];, <sub>(*5)</sub>

$data = new ArrayData($someArray); $fileOption = new FileOption($outputFile); $exporter = new CSVExporter(); $exporter->setOption($fileOption); $exporter->setInput($data); $exporter->export();, <sub>(*6)</sub>

## Add headers to control output CSV

Only ```baz``` and ```foo``` will be in the resulting CSV and the order of the columns will be as set in the HeadersOption.

``` php
$someArray = [
  ['foo' => 'foo', 'bar' => 'bar'],
  ['foo' => 'foobar', 'bar' => 'baz'],
  ['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'],
  ['foo' => 'bar', 'baz' => 'bar'],
  ['foo' => 'baz', 'bar' => 'foobar'],
];
$outputFile = 'output.csv';

$headers = new HeadersOption(['baz', 'foo']);
$data = new ArrayData($someArray);
$fileOption = new FileOption($outputFile);
$exporter = new CSVExporter();
$exporter->export($data, [$headersOption, $fileOption]);

Output to multiple files

``` php $someArray = [ ['foo' => 'foo', 'bar' => 'bar'], ['foo' => 'foobar', 'bar' => 'baz'], ['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'], ['foo' => 'bar', 'baz' => 'bar'], ['foo' => 'baz', 'bar' => 'foobar'], ]; $outputFile = 'output.csv'; $otherFile = sprintf('/data/dropbox/output-%s.csv', date('Ymd'));, <sub>(*7)</sub>

$headers = new HeadersOption(['baz', 'foo']); $data = new ArrayData($someArray); $options = [ $headers, new FileOption($outputFile), new FileOption($otherFile), ];, <sub>(*8)</sub>

$exporter = new CSVExporter(); $exporter->export($data, $options);, <sub>(*9)</sub>

## Error Handling

``` php
$someArray = [
  ['foo' => 'foo', 'bar' => 'bar', ['impossible' => 'input']],
  ['foo' => 'foobar', 'bar' => 'baz'],
  ['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'],
  ['foo' => 'bar', 'baz' => 'bar'],
  ['foo' => 'baz', 'bar' => 'foobar'],
];
$outputFile = 'output.csv';
$otherFile = sprintf('/data/dropbox/output-%s.csv', date('Ymd'));

$headers = new HeadersOption(['baz', 'foo']);
$data = new ArrayData($someArray);
$options = [
  $headers,
  new FileOption($outputFile),
  new FileOption($otherFile),
];

try {
  $exporter = new CSVExporter();
  $exporter->export($data, $options);
} catch (UnsupportedDataException $e) {
  echo sprintf('The given input is not valid: %s', $e->getMessage());
}

Exporting multiple, similar input

``` php $someArray = [ ['foo' => 'foo', 'bar' => 'bar'], ['foo' => 'foobar', 'bar' => 'baz'], ['foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz'], ['foo' => 'bar', 'baz' => 'bar'], ['foo' => 'baz', 'bar' => 'foobar'], ]; $somePluralArray = [ ['foo' => 'foos', 'bar' => 'bars'], ['foo' => 'foobars', 'bar' => 'bazs'], ['foo' => 'foos', 'bar' => 'bars', 'baz' => 'bazs'], ['foo' => 'bars', 'baz' => 'bars'], ['foo' => 'bazs', 'bar' => 'foobars'], ];, <sub>(*10)</sub>

$headers = new HeadersOption(['baz', 'foo']); $exporter = new CSVExporter([$headers]);, <sub>(*11)</sub>

$outputFileOption = new FileOption('output.csv'); $outputPluralFileOption = new FileOption('outputs.csv');, <sub>(*12)</sub>

$inputData = new ArrayData($someArray); $inputPluralData = new ArrayData($somePlurarData);, <sub>(*13)</sub>

$exporter->setOption($outputFileOption, true); $exporter->export($inputData);, <sub>(*14)</sub>

$exporter->setOption($outputPluralFileOption, true); $exporter->export($inputPluralData); ```, <sub>(*15)</sub>