Improve pdf engines

8ctopus · May 1, 2024 · 695592a · 695592a
1 parent 8c0fe1f
commit 695592a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -108,14 +108,19 @@ $pdf = $invoice->renderPdf([
     'orientation' => 'portrait',
     // allow to download content from the internet such as fonts
     'isRemoteEnabled' => true,
-    // uncomment to use wk\<html\>topdf
-    //'engine' => 'alternate',
+    // valid options: CPDF, PDFLib, GD, wkhtmltopdf and auto
+    'pdfBackend' => 'CPDF',
 ]);
 
 file_put_contents('invoice.pdf', $pdf);
 ```
 
-## wk\<html\>topdf
+## pdf engines
+
+- `CPDF` is included within `DomPdf`
+- `PDFLib` is a commercial library https://www.pdflib.com/ that needs to be installed
+- `GD` will make a graphic pdf
+- `wk<html>topdf`
 
 To use the `wk<html>topdf` engine, you will need to [download the binary](https://wkhtmltopdf.org/downloads.html) for your system and add it to the current working directory `getcwd()` or to the system path.
 

diff --git a/demo.php b/demo.php
@@ -89,7 +89,7 @@
     'isRemoteEnabled' => true,
     'cache' => $cache,
     'debug' => true,
-    //'PDFLib', 'CPDF', 'GD', and 'auto'
+    // valid options: CPDF, PDFLib, GD, wkhtmltopdf and auto
     'pdfBackend' => 'CPDF',
 ]);
 

diff --git a/src/Invoice.php b/src/Invoice.php
@@ -126,7 +126,7 @@ public function renderHtml() : string
      */
     public function renderPdf(array $options = []) : string
     {
-        if (array_key_exists('engine', $options) && $options['engine'] === 'alternate') {
+        if (($options['engine'] ?? '') === 'wkhtmltopdf') {
             return $this->renderWK($options);
         }