Exports

- Added export functionality powered my maatwebsite/excel
- Added config item to override exporter class
- Added a new translation string
- Added a new export dropdown with export choices chosen from component classes $exports array
- Export to either csv, xls, or xlsx
- Add new option to add class to export button
- Added callback to column to be able to format the column differently for the exports
- Added a flag to omit a column from an export

Author: rappasoft

config/config.php

@@ -2,6 +2,11 @@
 
 return [
 
+    /*
+     * The class to use to handle the export functionality
+     */
+    'exports' => \Rappasoft\LaravelLivewireTables\Exports\Export::class,
+
     /*
      * The frontend styling framework to use
      * Options: bootstrap-4

resources/lang/ar/strings.php

@@ -2,6 +2,7 @@
 
 return [
     'clear' => 'مسح',
+    'export' => 'Export',
     'loading' => 'تحميل...',
     'no_results' => 'لا توجد نتائج لعرضها لهذا الاستعلام.',
     'offline' => 'أنت غير متصل حاليا بالإنترنت.',

resources/lang/en/strings.php

@@ -2,6 +2,7 @@
 
 return [
     'clear' => 'Clear',
+    'export' => 'Export',
     'loading' => 'Loading...',
     'no_results' => 'There are no results to display for this query.',
     'offline' => 'You are not currently connected to the internet.',

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

@@ -0,0 +1,21 @@
+@if (count($exports))
+    <div class="dropdown table-export">
+        <button class="dropdown-toggle {{ $this->getOption('bootstrap.classes.buttons.export') }}" type="button" id="dropdownMenuButton" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+            @lang('laravel-livewire-tables::strings.export')
+        </button>
+
+        <div class="dropdown-menu" aria-labelledby="dropdownMenuButton">
+            @if (in_array('csv', $exports, true))
+                <a class="dropdown-item" href="#" wire:click.prevent="export('csv')">CSV</a>
+            @endif
+
+            @if (in_array('xls', $exports, true))
+                <a class="dropdown-item" href="#" wire:click.prevent="export('xls')">XLS</a>
+            @endif
+
+            @if (in_array('xlsx', $exports, true))
+                <a class="dropdown-item" href="#" wire:click.prevent="export('xlsx')">XLSX</a>
+            @endif
+        </div>
+    </div><!--export-dropdown-->
+@endif

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

@@ -33,5 +33,7 @@ class="form-control"
                 @endif
             </div>
         @endif
+
+        @include('laravel-livewire-tables::'.config('laravel-livewire-tables.theme').'.includes.export')
     </div><!--row-->
 @endif

src/Exceptions/UnsupportedExportFormatException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Exceptions;
+
+use Exception;
+
+class UnsupportedExportFormatException extends Exception {}

src/Exports/Export.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Exports;
+
+use Illuminate\Database\Eloquent\Builder;
+use Maatwebsite\Excel\Concerns\Exportable;
+use Maatwebsite\Excel\Concerns\FromQuery;
+use Maatwebsite\Excel\Concerns\WithHeadings;
+use Maatwebsite\Excel\Concerns\WithMapping;
+use Rappasoft\LaravelLivewireTables\Traits\ExportHelper;
+
+/**
+ * Class CSVExport
+ *
+ * @package Rappasoft\LaravelLivewireTables\Exports
+ */
+class Export implements FromQuery, WithHeadings, WithMapping
+{
+
+    use Exportable, ExportHelper;
+
+    /**
+     * @var array
+     */
+    public $builder;
+
+    /**
+     * @var array
+     */
+    public $columns;
+
+    /**
+     * CSVExport constructor.
+     *
+     * @param  Builder  $builder
+     * @param  array  $columns
+     */
+    public function __construct(Builder $builder, array $columns = []) {
+        $this->builder = $builder;
+        $this->columns = $columns;
+    }
+
+    /**
+     * @return array|\Illuminate\Database\Query\Builder
+     */
+    public function query()
+    {
+        return $this->builder;
+    }
+
+    /**
+     * @return array
+     */
+    public function headings(): array
+    {
+        return $this->getHeadingRow();
+    }
+
+    /**
+     * @param  mixed  $row
+     *
+     * @return array
+     */
+    public function map($row): array
+    {
+        $map = [];
+
+        foreach ($this->columns as $column) {
+            if ($column->isVisible() && $column->includedInExport()) {
+                if ($column->isFormatted()) {
+                    if ($column->hasExportFormat()) {
+                        $map[] = $column->formattedForExport($row, $column);
+                    } else {
+                        $map[] = strip_tags($column->formatted($row, $column));
+                    }
+                } else {
+                    $map[] = data_get($row, $column->getAttribute());
+                }
+            }
+        }
+
+        return $map;
+    }
+}

src/TableComponent.php

@@ -7,6 +7,7 @@
 use Illuminate\View\View;
 use Livewire\Component;
 use Livewire\WithPagination;
+use Rappasoft\LaravelLivewireTables\Traits\Exports;
 use Rappasoft\LaravelLivewireTables\Traits\Loading;
 use Rappasoft\LaravelLivewireTables\Traits\Options;
 use Rappasoft\LaravelLivewireTables\Traits\Pagination;
@@ -20,7 +21,8 @@
  */
 abstract class TableComponent extends Component
 {
-    use Loading,
+    use Exports,
+        Loading,
         Options,
         Pagination,
         Search,

src/Traits/ExportHelper.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits;
+
+/**
+ * Trait ExportHelper.
+ */
+trait ExportHelper
+{
+
+    /**
+     * @return array
+     */
+    public function getHeadingRow(): array {
+        $headers = [];
+
+        foreach ($this->columns as $column) {
+            if ($column->isVisible() && $column->includedInExport()) {
+                $headers[] = $column->getText();
+            }
+        }
+
+        return $headers;
+    }
+}

src/Traits/Exports.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Rappasoft\LaravelLivewireTables\Traits;
+
+use Exception;
+use Maatwebsite\Excel\Excel;
+use Rappasoft\LaravelLivewireTables\Exceptions\UnsupportedExportFormatException;
+
+/**
+ * Trait Exports.
+ */
+trait Exports
+{
+
+    /**
+     * @var string
+     */
+    public $exportFileName = 'data';
+
+    /**
+     * @var bool
+     */
+    public $exports = [];
+
+    /**
+     * @param $type
+     *
+     * @return mixed
+     * @throws Exception
+     */
+    public function export($type) {
+        $type = strtolower($type);
+
+        if (!in_array($type, ['csv', 'xls', 'xlsx'], true)) {
+            throw new UnsupportedExportFormatException(__('This export type is not supported.'));
+        }
+
+        if (!in_array($type, array_map('strtolower', $this->exports), true)) {
+            throw new UnsupportedExportFormatException(__('This export type is not set on this table component.'));
+        }
+
+        switch ($type) {
+            case 'csv':default:
+                $writer = Excel::CSV;
+                break;
+
+            case 'xls':
+                $writer = Excel::XLS;
+                break;
+
+            case 'xlsx':
+                $writer = Excel::XLSX;
+                break;
+        }
+
+        $class = config('laravel-livewire-tables.exports');
+
+        return (new $class(
+            $this->models(),
+            $this->columns(),
+        ))->download($this->exportFileName.'.'.$type, $writer);
+    }
+}