123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230 |
- <?php
- namespace PhpOffice\PhpSpreadsheet;
- use PhpOffice\PhpSpreadsheet\Shared\File;
- /**
- * Factory to create readers and writers easily.
- *
- * It is not required to use this class, but it should make it easier to read and write files.
- * Especially for reading files with an unknown format.
- */
- abstract class IOFactory
- {
- 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,
- ];
- private static $writers = [
- 'Xls' => Writer\Xls::class,
- 'Xlsx' => Writer\Xlsx::class,
- 'Ods' => Writer\Ods::class,
- 'Csv' => Writer\Csv::class,
- 'Html' => Writer\Html::class,
- 'Tcpdf' => Writer\Pdf\Tcpdf::class,
- 'Dompdf' => Writer\Pdf\Dompdf::class,
- 'Mpdf' => Writer\Pdf\Mpdf::class,
- ];
- /**
- * Create Writer\IWriter.
- *
- * @param Spreadsheet $spreadsheet
- * @param string $writerType Example: Xlsx
- *
- * @throws Writer\Exception
- *
- * @return Writer\IWriter
- */
- public static function createWriter(Spreadsheet $spreadsheet, $writerType)
- {
- if (!isset(self::$writers[$writerType])) {
- throw new Writer\Exception("No writer found for type $writerType");
- }
- // Instantiate writer
- $className = self::$writers[$writerType];
- $writer = new $className($spreadsheet);
- return $writer;
- }
- /**
- * Create Reader\IReader.
- *
- * @param string $readerType Example: Xlsx
- *
- * @throws Reader\Exception
- *
- * @return Reader\IReader
- */
- public static function createReader($readerType)
- {
- if (!isset(self::$readers[$readerType])) {
- throw new Reader\Exception("No reader found for type $readerType");
- }
- // Instantiate reader
- $className = self::$readers[$readerType];
- $reader = new $className();
- return $reader;
- }
- /**
- * Loads Spreadsheet from file using automatic Reader\IReader resolution.
- *
- * @param string $pFilename The name of the spreadsheet file
- *
- * @throws Reader\Exception
- *
- * @return Spreadsheet
- */
- public static function load($pFilename)
- {
- $reader = self::createReaderForFile($pFilename);
- return $reader->load($pFilename);
- }
- /**
- * Identify file type using automatic Reader\IReader resolution.
- *
- * @param string $pFilename The name of the spreadsheet file to identify
- *
- * @throws Reader\Exception
- *
- * @return string
- */
- public static function identify($pFilename)
- {
- $reader = self::createReaderForFile($pFilename);
- $className = get_class($reader);
- $classType = explode('\\', $className);
- unset($reader);
- return array_pop($classType);
- }
- /**
- * Create Reader\IReader for file using automatic Reader\IReader resolution.
- *
- * @param string $filename The name of the spreadsheet file
- *
- * @throws Reader\Exception
- *
- * @return Reader\IReader
- */
- public static function createReaderForFile($filename)
- {
- File::assertFile($filename);
- // First, lucky guess by inspecting file extension
- $guessedReader = self::getReaderTypeFromExtension($filename);
- if ($guessedReader !== null) {
- $reader = self::createReader($guessedReader);
- // Let's see if we are lucky
- if (isset($reader) && $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) {
- // Ignore our original guess, we know that won't work
- if ($type !== $guessedReader) {
- $reader = self::createReader($type);
- if ($reader->canRead($filename)) {
- return $reader;
- }
- }
- }
- throw new Reader\Exception('Unable to identify a reader for this file');
- }
- /**
- * Guess a reader type from the file extension, if any.
- *
- * @param string $filename
- *
- * @return null|string
- */
- private static function getReaderTypeFromExtension($filename)
- {
- $pathinfo = pathinfo($filename);
- if (!isset($pathinfo['extension'])) {
- return null;
- }
- switch (strtolower($pathinfo['extension'])) {
- case 'xlsx': // Excel (OfficeOpenXML) Spreadsheet
- case 'xlsm': // Excel (OfficeOpenXML) Macro Spreadsheet (macros will be discarded)
- case 'xltx': // Excel (OfficeOpenXML) Template
- case 'xltm': // Excel (OfficeOpenXML) Macro Template (macros will be discarded)
- return 'Xlsx';
- case 'xls': // Excel (BIFF) Spreadsheet
- case 'xlt': // Excel (BIFF) Template
- return 'Xls';
- case 'ods': // Open/Libre Offic Calc
- case 'ots': // Open/Libre Offic Calc Template
- return 'Ods';
- case 'slk':
- return 'Slk';
- case 'xml': // Excel 2003 SpreadSheetML
- return 'Xml';
- case 'gnumeric':
- return 'Gnumeric';
- case 'htm':
- case 'html':
- return 'Html';
- case 'csv':
- // Do nothing
- // We must not try to use CSV reader since it loads
- // all files including Excel files etc.
- return null;
- default:
- return null;
- }
- }
- /**
- * Register a writer with its type and class name.
- *
- * @param string $writerType
- * @param string $writerClass
- */
- public static function registerWriter($writerType, $writerClass)
- {
- if (!is_a($writerClass, Writer\IWriter::class, true)) {
- throw new Writer\Exception('Registered writers must implement ' . Writer\IWriter::class);
- }
- self::$writers[$writerType] = $writerClass;
- }
- /**
- * Register a reader with its type and class name.
- *
- * @param string $readerType
- * @param string $readerClass
- */
- public static function registerReader($readerType, $readerClass)
- {
- if (!is_a($readerClass, Reader\IReader::class, true)) {
- throw new Reader\Exception('Registered readers must implement ' . Reader\IReader::class);
- }
- self::$readers[$readerType] = $readerClass;
- }
- }
|