40ee386edd
Removed the `ReaderEntityFactory::createReader(Type)` method and replaced it by 3 methods: - `ReaderEntityFactory::createCSVReader()` - `ReaderEntityFactory::createXLSXReader()` - `ReaderEntityFactory::createODSReader()` This has the advantage of enabling autocomplete in the IDE, as the return type is no longer the interface but the concrete type. Since readers may expose different options, this is pretty useful. Similarly, removed the `WriterEntityFactory::createWriter(Type)` method and replaced it by 3 methods: - `WriterEntityFactory::createCSVWriter()` - `WriterEntityFactory::createXLSXWriter()` - `WriterEntityFactory::createODSWriter()` Since this is a breaking change, I also updated the Upgrade guide. Finally, the doc is up to date too.
118 lines
3.1 KiB
PHP
118 lines
3.1 KiB
PHP
<?php
|
|
|
|
namespace Box\Spout\Writer\Common\Creator;
|
|
|
|
use Box\Spout\Common\Entity\Cell;
|
|
use Box\Spout\Common\Entity\Row;
|
|
use Box\Spout\Common\Entity\Style\Style;
|
|
use Box\Spout\Common\Exception\UnsupportedTypeException;
|
|
use Box\Spout\Common\Type;
|
|
use Box\Spout\Writer\WriterInterface;
|
|
|
|
/**
|
|
* Class WriterEntityFactory
|
|
* Factory to create external entities
|
|
*/
|
|
class WriterEntityFactory
|
|
{
|
|
/**
|
|
* This creates an instance of the appropriate writer, given the type of the file to be written
|
|
*
|
|
* @param string $writerType Type of the writer to instantiate
|
|
* @throws \Box\Spout\Common\Exception\UnsupportedTypeException
|
|
* @return WriterInterface
|
|
*/
|
|
public static function createWriter($writerType)
|
|
{
|
|
return WriterFactory::createFromType($writerType);
|
|
}
|
|
|
|
/**
|
|
* This creates an instance of the appropriate writer, given the extension of the file to be written
|
|
*
|
|
* @param string $path The path to the spreadsheet file. Supported extensions are .csv, .ods and .xlsx
|
|
* @throws \Box\Spout\Common\Exception\UnsupportedTypeException
|
|
* @return WriterInterface
|
|
*/
|
|
public static function createWriterFromFile(string $path)
|
|
{
|
|
return WriterFactory::createFromFile($path);
|
|
}
|
|
|
|
/**
|
|
* This creates an instance of a CSV writer
|
|
*
|
|
* @return \Box\Spout\Writer\CSV\Writer
|
|
*/
|
|
public static function createCSVWriter()
|
|
{
|
|
try {
|
|
return WriterFactory::createFromType(Type::CSV);
|
|
} catch (UnsupportedTypeException $e) {
|
|
// should never happen
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This creates an instance of a XLSX writer
|
|
*
|
|
* @return \Box\Spout\Writer\XLSX\Writer
|
|
*/
|
|
public static function createXLSXWriter()
|
|
{
|
|
try {
|
|
return WriterFactory::createFromType(Type::XLSX);
|
|
} catch (UnsupportedTypeException $e) {
|
|
// should never happen
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This creates an instance of a ODS writer
|
|
*
|
|
* @return \Box\Spout\Writer\ODS\Writer
|
|
*/
|
|
public static function createODSWriter()
|
|
{
|
|
try {
|
|
return WriterFactory::createFromType(Type::ODS);
|
|
} catch (UnsupportedTypeException $e) {
|
|
// should never happen
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param Cell[] $cells
|
|
* @param Style|null $rowStyle
|
|
* @return Row
|
|
*/
|
|
public static function createRow(array $cells = [], Style $rowStyle = null)
|
|
{
|
|
return new Row($cells, $rowStyle);
|
|
}
|
|
|
|
/**
|
|
* @param array $cellValues
|
|
* @param Style|null $rowStyle
|
|
* @return Row
|
|
*/
|
|
public static function createRowFromArray(array $cellValues = [], Style $rowStyle = null)
|
|
{
|
|
$cells = array_map(function ($cellValue) {
|
|
return new Cell($cellValue);
|
|
}, $cellValues);
|
|
|
|
return new Row($cells, $rowStyle);
|
|
}
|
|
|
|
/**
|
|
* @param mixed $cellValue
|
|
* @param Style|null $cellStyle
|
|
* @return Cell
|
|
*/
|
|
public static function createCell($cellValue, Style $cellStyle = null)
|
|
{
|
|
return new Cell($cellValue, $cellStyle);
|
|
}
|
|
}
|