PDF Support

- Add pdf support with either dompdf or mpdf libraries
- Added choice in config file
- Added option for exportOnly on a column

Author: rappasoft

config/config.php

@@ -7,6 +7,15 @@
      */
     'exports' => \Rappasoft\LaravelLivewireTables\Exports\Export::class,
 
+    /*
+     * Which library you want to use for PDF generation
+     * Supports dompdf, mpdf
+     * You must install the appropriate third party package for each
+     * See: https://docs.laravel-excel.com/3.1/exports/export-formats.html
+     * And: https://phpspreadsheet.readthedocs.io/en/latest/topics/reading-and-writing-to-file/#pdf
+     */
+    'pdf_library' => 'dompdf',
+
     /*
      * The frontend styling framework to use
      * Options: bootstrap-4

resources/views/bootstrap-4/includes/export.blade.php

@@ -16,6 +16,10 @@
             @if (in_array('xlsx', $exports, true))
                 <a class="dropdown-item" href="#" wire:click.prevent="export('xlsx')">XLSX</a>
             @endif
+
+            @if (in_array('pdf', $exports, true))
+                <a class="dropdown-item" href="#" wire:click.prevent="export('pdf')">PDF</a>
+            @endif
         </div>
     </div><!--export-dropdown-->
 @endif

src/Exports/Export.php

@@ -64,7 +64,7 @@ public function map($row): array
         $map = [];
 
         foreach ($this->columns as $column) {
-            if ($column->isVisible() && $column->includedInExport()) {
+            if ($column->isExportOnly() || ($column->isVisible() && $column->includedInExport())) {
                 if ($column->isFormatted()) {
                     if ($column->hasExportFormat()) {
                         $map[] = $column->formattedForExport($row, $column);

src/Traits/ExportHelper.php

@@ -15,7 +15,7 @@ public function getHeadingRow(): array
         $headers = [];
 
         foreach ($this->columns as $column) {
-            if ($column->isVisible() && $column->includedInExport()) {
+            if ($column->isExportOnly() || ($column->isVisible() && $column->includedInExport())) {
                 $headers[] = $column->getText();
             }
         }

src/Traits/Exports.php

@@ -31,7 +31,7 @@ public function export($type)
     {
         $type = strtolower($type);
 
-        if (! in_array($type, ['csv', 'xls', 'xlsx'], true)) {
+        if (! in_array($type, ['csv', 'xls', 'xlsx', 'pdf'], true)) {
             throw new UnsupportedExportFormatException(__('This export type is not supported.'));
         }
 
@@ -42,15 +42,28 @@ public function export($type)
         switch ($type) {
             case 'csv':default:
                 $writer = Excel::CSV;
-                break;
+            break;
 
             case 'xls':
                 $writer = Excel::XLS;
-                break;
+            break;
 
             case 'xlsx':
                 $writer = Excel::XLSX;
-                break;
+            break;
+
+            case 'pdf':
+                $writer = Excel::DOMPDF;
+                $library = strtolower(config('laravel-livewire-tables.pdf_library'));
+
+                if (! in_array($library, ['dompdf', 'mpdf'], true)) {
+                    throw new UnsupportedExportFormatException(__('This PDF export library is not supported.'));
+                }
+
+                if ($library === 'mpdf') {
+                    $writer = Excel::MPDF;
+                }
+            break;
         }
 
         $class = config('laravel-livewire-tables.exports');

src/Traits/Options.php

@@ -21,7 +21,7 @@ trait Options
         'bootstrap' => [
             'classes' => [
                 'buttons' => [
-                    'export' => 'btn btn-info',
+                    'export' => 'btn',
                 ],
                 'table' => 'table table-bordered table-striped',
                 'thead' => null,

src/Views/Column.php

@@ -37,6 +37,16 @@ class Column
      */
     protected $raw = false;
 
+    /**
+     * @var bool
+     */
+    protected $includeInExport = true;
+
+    /**
+     * @var bool
+     */
+    protected $exportOnly = false;
+
     /**
      * @var
      */
@@ -57,11 +67,6 @@ class Column
      */
     protected $searchCallback;
 
-    /**
-     * @var bool
-     */
-    protected $includeInExport = true;
-
     /**
      * Column constructor.
      *
@@ -247,6 +252,25 @@ public function includedInExport(): bool
         return $this->includeInExport === true;
     }
 
+    /**
+     * @return $this
+     */
+    public function exportOnly(): self
+    {
+        $this->hidden = true;
+        $this->exportOnly = true;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isExportOnly(): bool
+    {
+        return $this->exportOnly === true;
+    }
+
     /**
      * @return $this
      */