package and depencies
This commit is contained in:
RafficMohammed
@@ -2,7 +2,9 @@
|
||||
|
||||
namespace PhpOffice\PhpSpreadsheet;
|
||||
|
||||
use PhpOffice\PhpSpreadsheet\Reader\IReader;
|
||||
use PhpOffice\PhpSpreadsheet\Shared\File;
|
||||
use PhpOffice\PhpSpreadsheet\Writer\IWriter;
|
||||
|
||||
/**
|
||||
* Factory to create readers and writers easily.
|
||||
@@ -12,23 +14,39 @@ use PhpOffice\PhpSpreadsheet\Shared\File;
|
||||
*/
|
||||
abstract class IOFactory
|
||||
{
|
||||
public const READER_XLSX = 'Xlsx';
|
||||
public const READER_XLS = 'Xls';
|
||||
public const READER_XML = 'Xml';
|
||||
public const READER_ODS = 'Ods';
|
||||
public const READER_SYLK = 'Slk';
|
||||
public const READER_SLK = 'Slk';
|
||||
public const READER_GNUMERIC = 'Gnumeric';
|
||||
public const READER_HTML = 'Html';
|
||||
public const READER_CSV = 'Csv';
|
||||
|
||||
public const WRITER_XLSX = 'Xlsx';
|
||||
public const WRITER_XLS = 'Xls';
|
||||
public const WRITER_ODS = 'Ods';
|
||||
public const WRITER_CSV = 'Csv';
|
||||
public const WRITER_HTML = 'Html';
|
||||
|
||||
private static $readers = [
|
||||
'Xlsx' => Reader\Xlsx::class,
|
||||
'Xls' => Reader\Xls::class,
|
||||
'Xml' => Reader\Xml::class,
|
||||
'Ods' => Reader\Ods::class,
|
||||
'Slk' => Reader\Slk::class,
|
||||
'Gnumeric' => Reader\Gnumeric::class,
|
||||
'Html' => Reader\Html::class,
|
||||
'Csv' => Reader\Csv::class,
|
||||
self::READER_XLSX => Reader\Xlsx::class,
|
||||
self::READER_XLS => Reader\Xls::class,
|
||||
self::READER_XML => Reader\Xml::class,
|
||||
self::READER_ODS => Reader\Ods::class,
|
||||
self::READER_SLK => Reader\Slk::class,
|
||||
self::READER_GNUMERIC => Reader\Gnumeric::class,
|
||||
self::READER_HTML => Reader\Html::class,
|
||||
self::READER_CSV => Reader\Csv::class,
|
||||
];
|
||||
|
||||
private static $writers = [
|
||||
'Xls' => Writer\Xls::class,
|
||||
'Xlsx' => Writer\Xlsx::class,
|
||||
'Ods' => Writer\Ods::class,
|
||||
'Csv' => Writer\Csv::class,
|
||||
'Html' => Writer\Html::class,
|
||||
self::WRITER_XLS => Writer\Xls::class,
|
||||
self::WRITER_XLSX => Writer\Xlsx::class,
|
||||
self::WRITER_ODS => Writer\Ods::class,
|
||||
self::WRITER_CSV => Writer\Csv::class,
|
||||
self::WRITER_HTML => Writer\Html::class,
|
||||
'Tcpdf' => Writer\Pdf\Tcpdf::class,
|
||||
'Dompdf' => Writer\Pdf\Dompdf::class,
|
||||
'Mpdf' => Writer\Pdf\Mpdf::class,
|
||||
@@ -36,12 +54,8 @@ abstract class IOFactory
|
||||
|
||||
/**
|
||||
* Create Writer\IWriter.
|
||||
*
|
||||
* @param string $writerType Example: Xlsx
|
||||
*
|
||||
* @return Writer\IWriter
|
||||
*/
|
||||
public static function createWriter(Spreadsheet $spreadsheet, $writerType)
|
||||
public static function createWriter(Spreadsheet $spreadsheet, string $writerType): IWriter
|
||||
{
|
||||
if (!isset(self::$writers[$writerType])) {
|
||||
throw new Writer\Exception("No writer found for type $writerType");
|
||||
@@ -54,13 +68,9 @@ abstract class IOFactory
|
||||
}
|
||||
|
||||
/**
|
||||
* Create Reader\IReader.
|
||||
*
|
||||
* @param string $readerType Example: Xlsx
|
||||
*
|
||||
* @return Reader\IReader
|
||||
* Create IReader.
|
||||
*/
|
||||
public static function createReader($readerType)
|
||||
public static function createReader(string $readerType): IReader
|
||||
{
|
||||
if (!isset(self::$readers[$readerType])) {
|
||||
throw new Reader\Exception("No reader found for type $readerType");
|
||||
@@ -75,27 +85,29 @@ abstract class IOFactory
|
||||
/**
|
||||
* Loads Spreadsheet from file using automatic Reader\IReader resolution.
|
||||
*
|
||||
* @param string $pFilename The name of the spreadsheet file
|
||||
*
|
||||
* @return Spreadsheet
|
||||
* @param string $filename The name of the spreadsheet file
|
||||
* @param int $flags the optional second parameter flags may be used to identify specific elements
|
||||
* that should be loaded, but which won't be loaded by default, using these values:
|
||||
* IReader::LOAD_WITH_CHARTS - Include any charts that are defined in the loaded file
|
||||
* @param string[] $readers An array of Readers to use to identify the file type. By default, load() will try
|
||||
* all possible Readers until it finds a match; but this allows you to pass in a
|
||||
* list of Readers so it will only try the subset that you specify here.
|
||||
* Values in this list can be any of the constant values defined in the set
|
||||
* IOFactory::READER_*.
|
||||
*/
|
||||
public static function load($pFilename)
|
||||
public static function load(string $filename, int $flags = 0, ?array $readers = null): Spreadsheet
|
||||
{
|
||||
$reader = self::createReaderForFile($pFilename);
|
||||
$reader = self::createReaderForFile($filename, $readers);
|
||||
|
||||
return $reader->load($pFilename);
|
||||
return $reader->load($filename, $flags);
|
||||
}
|
||||
|
||||
/**
|
||||
* Identify file type using automatic Reader\IReader resolution.
|
||||
*
|
||||
* @param string $pFilename The name of the spreadsheet file to identify
|
||||
*
|
||||
* @return string
|
||||
* Identify file type using automatic IReader resolution.
|
||||
*/
|
||||
public static function identify($pFilename)
|
||||
public static function identify(string $filename, ?array $readers = null): string
|
||||
{
|
||||
$reader = self::createReaderForFile($pFilename);
|
||||
$reader = self::createReaderForFile($filename, $readers);
|
||||
$className = get_class($reader);
|
||||
$classType = explode('\\', $className);
|
||||
unset($reader);
|
||||
@@ -104,33 +116,47 @@ abstract class IOFactory
|
||||
}
|
||||
|
||||
/**
|
||||
* Create Reader\IReader for file using automatic Reader\IReader resolution.
|
||||
* Create Reader\IReader for file using automatic IReader resolution.
|
||||
*
|
||||
* @param string $filename The name of the spreadsheet file
|
||||
*
|
||||
* @return Reader\IReader
|
||||
* @param string[] $readers An array of Readers to use to identify the file type. By default, load() will try
|
||||
* all possible Readers until it finds a match; but this allows you to pass in a
|
||||
* list of Readers so it will only try the subset that you specify here.
|
||||
* Values in this list can be any of the constant values defined in the set
|
||||
* IOFactory::READER_*.
|
||||
*/
|
||||
public static function createReaderForFile($filename)
|
||||
public static function createReaderForFile(string $filename, ?array $readers = null): IReader
|
||||
{
|
||||
File::assertFile($filename);
|
||||
|
||||
$testReaders = self::$readers;
|
||||
if ($readers !== null) {
|
||||
$readers = array_map('strtoupper', $readers);
|
||||
$testReaders = array_filter(
|
||||
self::$readers,
|
||||
function (string $readerType) use ($readers) {
|
||||
return in_array(strtoupper($readerType), $readers, true);
|
||||
},
|
||||
ARRAY_FILTER_USE_KEY
|
||||
);
|
||||
}
|
||||
|
||||
// First, lucky guess by inspecting file extension
|
||||
$guessedReader = self::getReaderTypeFromExtension($filename);
|
||||
if ($guessedReader !== null) {
|
||||
if (($guessedReader !== null) && array_key_exists($guessedReader, $testReaders)) {
|
||||
$reader = self::createReader($guessedReader);
|
||||
|
||||
// Let's see if we are lucky
|
||||
if (isset($reader) && $reader->canRead($filename)) {
|
||||
if ($reader->canRead($filename)) {
|
||||
return $reader;
|
||||
}
|
||||
}
|
||||
|
||||
// If we reach here then "lucky guess" didn't give any result
|
||||
// Try walking through all the options in self::$autoResolveClasses
|
||||
foreach (self::$readers as $type => $class) {
|
||||
// Try walking through all the options in self::$readers (or the selected subset)
|
||||
foreach ($testReaders as $readerType => $class) {
|
||||
// Ignore our original guess, we know that won't work
|
||||
if ($type !== $guessedReader) {
|
||||
$reader = self::createReader($type);
|
||||
if ($readerType !== $guessedReader) {
|
||||
$reader = self::createReader($readerType);
|
||||
if ($reader->canRead($filename)) {
|
||||
return $reader;
|
||||
}
|
||||
@@ -142,12 +168,8 @@ abstract class IOFactory
|
||||
|
||||
/**
|
||||
* Guess a reader type from the file extension, if any.
|
||||
*
|
||||
* @param string $filename
|
||||
*
|
||||
* @return null|string
|
||||
*/
|
||||
private static function getReaderTypeFromExtension($filename)
|
||||
private static function getReaderTypeFromExtension(string $filename): ?string
|
||||
{
|
||||
$pathinfo = pathinfo($filename);
|
||||
if (!isset($pathinfo['extension'])) {
|
||||
@@ -187,14 +209,11 @@ abstract class IOFactory
|
||||
|
||||
/**
|
||||
* Register a writer with its type and class name.
|
||||
*
|
||||
* @param string $writerType
|
||||
* @param string $writerClass
|
||||
*/
|
||||
public static function registerWriter($writerType, $writerClass): void
|
||||
public static function registerWriter(string $writerType, string $writerClass): void
|
||||
{
|
||||
if (!is_a($writerClass, Writer\IWriter::class, true)) {
|
||||
throw new Writer\Exception('Registered writers must implement ' . Writer\IWriter::class);
|
||||
if (!is_a($writerClass, IWriter::class, true)) {
|
||||
throw new Writer\Exception('Registered writers must implement ' . IWriter::class);
|
||||
}
|
||||
|
||||
self::$writers[$writerType] = $writerClass;
|
||||
@@ -202,14 +221,11 @@ abstract class IOFactory
|
||||
|
||||
/**
|
||||
* Register a reader with its type and class name.
|
||||
*
|
||||
* @param string $readerType
|
||||
* @param string $readerClass
|
||||
*/
|
||||
public static function registerReader($readerType, $readerClass): void
|
||||
public static function registerReader(string $readerType, string $readerClass): void
|
||||
{
|
||||
if (!is_a($readerClass, Reader\IReader::class, true)) {
|
||||
throw new Reader\Exception('Registered readers must implement ' . Reader\IReader::class);
|
||||
if (!is_a($readerClass, IReader::class, true)) {
|
||||
throw new Reader\Exception('Registered readers must implement ' . IReader::class);
|
||||
}
|
||||
|
||||
self::$readers[$readerType] = $readerClass;
|
||||
|
||||
Reference in New Issue
Block a user