Simplify IOFactory to rely on autoloading

Author: PowerKiKi

CHANGELOG.md

@@ -27,6 +27,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### BREAKING CHANGE
 
 - Standardization of array keys used for style, see the [migration guide](./docs/topics/migration-from-PHPExcel.md).
+- Easier usage of PDF writers, and other custom readers and writers, see the [migration guide](./docs/topics/migration-from-PHPExcel.md).
 
 ## [1.0.0-beta] - 2017-08-17
 

docs/index.md

@@ -19,7 +19,7 @@ spreadsheet file formats, like Excel and LibreOffice Calc.
 |HTML                                        |   ✓   |   ✓   |
 |SYLK                                        |   ✓   |       |
 |CSV                                         |   ✓   |   ✓   |
-|PDF (using either the tcPDF, DomPDF or mPDF libraries, which need to be installed separately)|       |   ✓   |
+|PDF (using either the TCPDF, Dompdf or mPDF libraries, which need to be installed separately)|       |   ✓   |
 
 # Getting started
 

docs/topics/migration-from-PHPExcel.md

@@ -43,6 +43,28 @@ Before           | After
 `'PDF'`          | `'Pdf'`
 `'SYLK'`         | `'Slk'`
 
+### Simplified IOFactory
+
+The following methods :
+
+- `PHPExcel_IOFactory::getSearchLocations()`
+- `PHPExcel_IOFactory::setSearchLocations()`
+- `PHPExcel_IOFactory::addSearchLocation()`
+
+were replaced by `IOFactory::registerReader()` and `IOFactory::registerWriter()`. That means
+IOFactory now relies on classes autoloading.
+
+Before:
+
+```php
+\PHPExcel_IOFactory::addSearchLocation($type, $location, $classname);
+```
+
+After:
+
+```php
+\PhpOffice\PhpSpreadsheet\IOFactory::registerReader($type, $classname);
+```
 
 ### Removed deprecated things
 
@@ -148,15 +170,33 @@ autoloading mechanism.
 
 ### Writing PDF
 
-`PHPExcel_Settings::getPdfRenderer()` and `PHPExcel_Settings::setPdfRenderer()`
-were removed. `PHPExcel_Settings::getPdfRendererName()` and
-`PHPExcel_Settings::setPdfRendererName()` were renamed as `setDefaultPdfWriter()`
-and `setDefaultPdfWriter()` respectively. And PDF libraries must be installed via
-composer. So the only thing to do is to specify a default writer class like so:
+PDF libraries must be installed via composer. And the following methods were removed
+and are replaced by `IOFactory::registerWriter()` instead:
+
+- `PHPExcel_Settings::getPdfRenderer()`
+- `PHPExcel_Settings::setPdfRenderer()`
+- `PHPExcel_Settings::getPdfRendererName()`
+- `PHPExcel_Settings::setPdfRendererName()` were renamed as `setDefaultPdfWriter()`
+
+Before:
 
 ```php
-$rendererName = \PhpOffice\PhpSpreadsheet\Writer\Pdf\MPDF::class;
-\PhpOffice\PhpSpreadsheet\Settings::setDefaultPdfWriter($rendererName);
+\PHPExcel_Settings::setPdfRendererName(PHPExcel_Settings::PDF_RENDERER_MPDF);
+\PHPExcel_Settings::setPdfRenderer($somePath);
+$writer = \PHPExcel_IOFactory::createWriter($spreadsheet, 'PDF');
+```
+
+After:
+
+```php
+$writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Mpdf');
+
+// Or alternatively
+\PhpOffice\PhpSpreadsheet\IOFactory::registerWriter('Pdf', \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class);
+$writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Pdf');
+
+// Or alternatively
+$writer = new \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
 ```
 
 ### PclZip and ZipArchive

docs/topics/reading-and-writing-to-file.md

@@ -739,37 +739,44 @@ regarding to styling cells, number formatting, ...
 ### \PhpOffice\PhpSpreadsheet\Writer\Pdf
 
 PhpSpreadsheet’s PDF Writer is a wrapper for a 3rd-Party PDF Rendering
-library such as tcPDF, mPDF or DomPDF. You must now install a PDF
+library such as TCPDF, mPDF or Dompdf. You must now install a PDF
 rendering library yourself; but PhpSpreadsheet will work with a number
 of different libraries.
 
 Currently, the following libraries are supported:
 
 Library | Downloadable from                   | PhpSpreadsheet writer
 --------|-------------------------------------|----------------------
-tcPDF   | https://github.com/tecnickcom/tcpdf | TcPdf
-mPDF    | https://github.com/mpdf/mpdf        | MPDF
-domPDF  | https://github.com/dompdf/dompdf    | DomPDF
+TCPDF   | https://github.com/tecnickcom/tcpdf | Tcpdf
+mPDF    | https://github.com/mpdf/mpdf        | Mpdf
+Dompdf  | https://github.com/dompdf/dompdf    | Dompdf
 
 The different libraries have different strengths and weaknesses. Some
 generate better formatted output than others, some are faster or use
 less memory than others, while some generate smaller .pdf files. It is
 the developers choice which one they wish to use, appropriate to their
 own circumstances.
 
-Before instantiating a Writer via `IOFactory` to generate PDF output,
-you will need to indicate which writer you are using:
+You can instantiate a writer with its specific name, like so:
 
 ``` php
-$rendererName = \PhpOffice\PhpSpreadsheet\Writer\Pdf\MPDF::class;
-\PhpOffice\PhpSpreadsheet\Settings::setDefaultPdfWriter($rendererName);
-$writer = \PhpOffice\PhpSpreadsheet\IOFactory\IOFactory::createWriter($spreadsheet, 'Pdf');
+$writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Mpdf');
+```
+
+Or you can register which writer you are using with a more generic name,
+so you don't need to remember which library you chose, only that you want
+to write PDF files:
+
+``` php
+$class = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class;
+\PhpOffice\PhpSpreadsheet\IOFactory::registerWriter('Pdf', $class);
+$writer = \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet, 'Pdf');
 ```
 
 Or you can instantiate directly the writer of your choice like so:
 
 ``` php
-$writer = \PhpOffice\PhpSpreadsheet\Writer\Pdf\MPDF($spreadsheet);
+$writer = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
 ```
 
 #### Writing a spreadsheet
@@ -778,7 +785,7 @@ Once you have identified the Renderer that you wish to use for PDF
 generation, you can write a .pdf file using the following code:
 
 ``` php
-$writer = new \PhpOffice\PhpSpreadsheet\Writer\Pdf\MPDF($spreadsheet);
+$writer = new \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
 $writer->save("05featuredemo.pdf");
 ```
 
@@ -810,7 +817,7 @@ This can be slow on large spreadsheets, and maybe even unwanted. You can
 however disable formula pre-calculation:
 
 ``` php
-$writer = new \PhpOffice\PhpSpreadsheet\Writer\Pdf\MPDF($spreadsheet);
+$writer = new \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf($spreadsheet);
 $writer->setPreCalculateFormulas(false);
 
 $writer->save("05featuredemo.pdf");

samples/Basic/01_Simple_download_pdf.php

@@ -2,7 +2,6 @@
 
 use PhpOffice\PhpSpreadsheet\Helper\Sample;
 use PhpOffice\PhpSpreadsheet\IOFactory;
-use PhpOffice\PhpSpreadsheet\Settings;
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
 
 require_once __DIR__ . '/../../src/Bootstrap.php';
@@ -14,10 +13,6 @@
     return;
 }
 
-//	Change these values to select the Rendering library that you wish to use
-//		and its directory location on your server
-$rendererName = \PhpOffice\PhpSpreadsheet\Writer\Pdf\MPDF::class;
-
 // Create new Spreadsheet object
 $spreadsheet = new Spreadsheet();
 
@@ -49,7 +44,7 @@
 // Set active sheet index to the first sheet, so Excel opens this as the first sheet
 $spreadsheet->setActiveSheetIndex(0);
 
-Settings::setDefaultPdfWriter($rendererName);
+IOFactory::registerWriter('Pdf', \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class);
 
 // Redirect output to a client’s web browser (PDF)
 header('Content-Type: application/pdf');

samples/Basic/26_Utf8.php

@@ -1,14 +1,9 @@
 <?php
 
 use PhpOffice\PhpSpreadsheet\IOFactory;
-use PhpOffice\PhpSpreadsheet\Settings;
 
 require __DIR__ . '/../Header.php';
 
-//	Change these values to select the PDF Rendering library that you wish to use
-//		and its directory location on your server
-$rendererName = \PhpOffice\PhpSpreadsheet\Writer\Pdf\DomPDF::class;
-
 // Read from Xlsx (.xlsx) template
 $helper->log('Load Xlsx template file');
 $reader = IOFactory::createReader('Xlsx');
@@ -19,7 +14,7 @@
 
 // Export to PDF (.pdf)
 $helper->log('Write to PDF format');
-Settings::setDefaultPdfWriter($rendererName);
+IOFactory::registerWriter('Pdf', \PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf::class);
 $helper->write($spreadsheet, __FILE__, ['Pdf']);
 
 // Remove first two rows with field headers before exporting to CSV

samples/Chart/32_Chart_read_write_PDF.php

@@ -5,11 +5,7 @@
 
 require __DIR__ . '/../Header.php';
 
-//	Change these values to select the Rendering library that you wish to use
-//		for PDF files, and its directory location on your server
-$rendererName = \PhpOffice\PhpSpreadsheet\Writer\Pdf\MPDF::class;
-
-Settings::setDefaultPdfWriter($rendererName);
+IOFactory::registerWriter('Pdf', \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class);
 
 //	Change these values to select the Rendering library that you wish to use
 //		for Chart images, and its directory location on your server

samples/Pdf/21_Pdf_Domdf.php

@@ -1,6 +1,6 @@
 <?php
 
-use PhpOffice\PhpSpreadsheet\Settings;
+use PhpOffice\PhpSpreadsheet\IOFactory;
 use PhpOffice\PhpSpreadsheet\Worksheet\PageSetup;
 
 require __DIR__ . '/../Header.php';
@@ -12,9 +12,9 @@
 $helper->log('Set orientation to landscape');
 $spreadsheet->getActiveSheet()->getPageSetup()->setOrientation(PageSetup::ORIENTATION_LANDSCAPE);
 
-$rendererName = \PhpOffice\PhpSpreadsheet\Writer\Pdf\DomPDF::class;
-$helper->log("Write to PDF format using {$rendererName}");
-Settings::setDefaultPdfWriter($rendererName);
+$className = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf::class;
+$helper->log("Write to PDF format using {$className}");
+IOFactory::registerWriter('Pdf', $className);
 
 // Save
 $helper->write($spreadsheet, __FILE__, ['Pdf']);

samples/Pdf/21_Pdf_TCPDF.php

@@ -1,6 +1,6 @@
 <?php
 
-use PhpOffice\PhpSpreadsheet\Settings;
+use PhpOffice\PhpSpreadsheet\IOFactory;
 use PhpOffice\PhpSpreadsheet\Worksheet\PageSetup;
 
 require __DIR__ . '/../Header.php';
@@ -12,9 +12,9 @@
 $helper->log('Set orientation to landscape');
 $spreadsheet->getActiveSheet()->getPageSetup()->setOrientation(PageSetup::ORIENTATION_LANDSCAPE);
 
-$rendererName = \PhpOffice\PhpSpreadsheet\Writer\Pdf\TcPDF::class;
-$helper->log("Write to PDF format using {$rendererName}");
-Settings::setDefaultPdfWriter($rendererName);
+$className = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Tcpdf::class;
+$helper->log("Write to PDF format using {$className}");
+IOFactory::registerWriter('Pdf', $className);
 
 // Save
 $helper->write($spreadsheet, __FILE__, ['Pdf']);

samples/Pdf/21_Pdf_mPDF.php

@@ -1,6 +1,6 @@
 <?php
 
-use PhpOffice\PhpSpreadsheet\Settings;
+use PhpOffice\PhpSpreadsheet\IOFactory;
 use PhpOffice\PhpSpreadsheet\Worksheet\PageSetup;
 
 require __DIR__ . '/../Header.php';
@@ -12,9 +12,9 @@
 $helper->log('Set orientation to landscape');
 $spreadsheet->getActiveSheet()->getPageSetup()->setOrientation(PageSetup::ORIENTATION_LANDSCAPE);
 
-$rendererName = \PhpOffice\PhpSpreadsheet\Writer\Pdf\MPDF::class;
-$helper->log("Write to PDF format using {$rendererName}");
-Settings::setDefaultPdfWriter($rendererName);
+$className = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Mpdf::class;
+$helper->log("Write to PDF format using {$className}");
+IOFactory::registerWriter('Pdf', $className);
 
 // Save
 $helper->write($spreadsheet, __FILE__, ['Pdf']);