visualizer / vendor / phpoffice / phpspreadsheet / src / PhpSpreadsheet / IOFactory.php

IOFactory.php in Visualizer – Tables & Charts Manager with Built-in AI Generator 3.10.8, at vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/IOFactory.php

231 lines 6.7 KB

Raw Download Zip

1	<?php
2
3	namespace PhpOffice\PhpSpreadsheet;
4
5	use PhpOffice\PhpSpreadsheet\Shared\File;
6
7	/**
8	* Factory to create readers and writers easily.
9	*
10	* It is not required to use this class, but it should make it easier to read and write files.
11	* Especially for reading files with an unknown format.
12	*/
13	abstract class IOFactory
14	{
15	private static $readers = [
16	'Xlsx' => Reader\Xlsx::class,
17	'Xls' => Reader\Xls::class,
18	'Xml' => Reader\Xml::class,
19	'Ods' => Reader\Ods::class,
20	'Slk' => Reader\Slk::class,
21	'Gnumeric' => Reader\Gnumeric::class,
22	'Html' => Reader\Html::class,
23	'Csv' => Reader\Csv::class,
24	];
25
26	private static $writers = [
27	'Xls' => Writer\Xls::class,
28	'Xlsx' => Writer\Xlsx::class,
29	'Ods' => Writer\Ods::class,
30	'Csv' => Writer\Csv::class,
31	'Html' => Writer\Html::class,
32	'Tcpdf' => Writer\Pdf\Tcpdf::class,
33	'Dompdf' => Writer\Pdf\Dompdf::class,
34	'Mpdf' => Writer\Pdf\Mpdf::class,
35	];
36
37	/**
38	* Create Writer\IWriter.
39	*
40	* @param Spreadsheet $spreadsheet
41	* @param string $writerType Example: Xlsx
42	*
43	* @throws Writer\Exception
44	*
45	* @return Writer\IWriter
46	*/
47	public static function createWriter(Spreadsheet $spreadsheet, $writerType)
48	{
49	if (!isset(self::$writers[$writerType])) {
50	throw new Writer\Exception("No writer found for type $writerType");
51	}
52
53	// Instantiate writer
54	$className = self::$writers[$writerType];
55	$writer = new $className($spreadsheet);
56
57	return $writer;
58	}
59
60	/**
61	* Create Reader\IReader.
62	*
63	* @param string $readerType Example: Xlsx
64	*
65	* @throws Reader\Exception
66	*
67	* @return Reader\IReader
68	*/
69	public static function createReader($readerType)
70	{
71	if (!isset(self::$readers[$readerType])) {
72	throw new Reader\Exception("No reader found for type $readerType");
73	}
74
75	// Instantiate reader
76	$className = self::$readers[$readerType];
77	$reader = new $className();
78
79	return $reader;
80	}
81
82	/**
83	* Loads Spreadsheet from file using automatic Reader\IReader resolution.
84	*
85	* @param string $pFilename The name of the spreadsheet file
86	*
87	* @throws Reader\Exception
88	*
89	* @return Spreadsheet
90	*/
91	public static function load($pFilename)
92	{
93	$reader = self::createReaderForFile($pFilename);
94
95	return $reader->load($pFilename);
96	}
97
98	/**
99	* Identify file type using automatic Reader\IReader resolution.
100	*
101	* @param string $pFilename The name of the spreadsheet file to identify
102	*
103	* @throws Reader\Exception
104	*
105	* @return string
106	*/
107	public static function identify($pFilename)
108	{
109	$reader = self::createReaderForFile($pFilename);
110	$className = get_class($reader);
111	$classType = explode('\\', $className);
112	unset($reader);
113
114	return array_pop($classType);
115	}
116
117	/**
118	* Create Reader\IReader for file using automatic Reader\IReader resolution.
119	*
120	* @param string $filename The name of the spreadsheet file
121	*
122	* @throws Reader\Exception
123	*
124	* @return Reader\IReader
125	*/
126	public static function createReaderForFile($filename)
127	{
128	File::assertFile($filename);
129
130	// First, lucky guess by inspecting file extension
131	$guessedReader = self::getReaderTypeFromExtension($filename);
132	if ($guessedReader !== null) {
133	$reader = self::createReader($guessedReader);
134
135	// Let's see if we are lucky
136	if (isset($reader) && $reader->canRead($filename)) {
137	return $reader;
138	}
139	}
140
141	// If we reach here then "lucky guess" didn't give any result
142	// Try walking through all the options in self::$autoResolveClasses
143	foreach (self::$readers as $type => $class) {
144	// Ignore our original guess, we know that won't work
145	if ($type !== $guessedReader) {
146	$reader = self::createReader($type);
147	if ($reader->canRead($filename)) {
148	return $reader;
149	}
150	}
151	}
152
153	throw new Reader\Exception('Unable to identify a reader for this file');
154	}
155
156	/**
157	* Guess a reader type from the file extension, if any.
158	*
159	* @param string $filename
160	*
161	* @return null\|string
162	*/
163	private static function getReaderTypeFromExtension($filename)
164	{
165	$pathinfo = pathinfo($filename);
166	if (!isset($pathinfo['extension'])) {
167	return null;
168	}
169
170	switch (strtolower($pathinfo['extension'])) {
171	case 'xlsx': // Excel (OfficeOpenXML) Spreadsheet
172	case 'xlsm': // Excel (OfficeOpenXML) Macro Spreadsheet (macros will be discarded)
173	case 'xltx': // Excel (OfficeOpenXML) Template
174	case 'xltm': // Excel (OfficeOpenXML) Macro Template (macros will be discarded)
175	return 'Xlsx';
176	case 'xls': // Excel (BIFF) Spreadsheet
177	case 'xlt': // Excel (BIFF) Template
178	return 'Xls';
179	case 'ods': // Open/Libre Offic Calc
180	case 'ots': // Open/Libre Offic Calc Template
181	return 'Ods';
182	case 'slk':
183	return 'Slk';
184	case 'xml': // Excel 2003 SpreadSheetML
185	return 'Xml';
186	case 'gnumeric':
187	return 'Gnumeric';
188	case 'htm':
189	case 'html':
190	return 'Html';
191	case 'csv':
192	// Do nothing
193	// We must not try to use CSV reader since it loads
194	// all files including Excel files etc.
195	return null;
196	default:
197	return null;
198	}
199	}
200
201	/**
202	* Register a writer with its type and class name.
203	*
204	* @param string $writerType
205	* @param string $writerClass
206	*/
207	public static function registerWriter($writerType, $writerClass)
208	{
209	if (!is_a($writerClass, Writer\IWriter::class, true)) {
210	throw new Writer\Exception('Registered writers must implement ' . Writer\IWriter::class);
211	}
212
213	self::$writers[$writerType] = $writerClass;
214	}
215
216	/**
217	* Register a reader with its type and class name.
218	*
219	* @param string $readerType
220	* @param string $readerClass
221	*/
222	public static function registerReader($readerType, $readerClass)
223	{
224	if (!is_a($readerClass, Reader\IReader::class, true)) {
225	throw new Reader\Exception('Registered readers must implement ' . Reader\IReader::class);
226	}
227
228	self::$readers[$readerType] = $readerClass;
229	}
230	}
231