JeroenNoten\LaravelAdminLte\Components\Datatable

Complexity

Total Complexity

15

Size/Duplication

Total Lines	273
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	render()	0	3	1
A	makeButtonsCfg()	0	59	1
A	__construct()	0	32	6
A	makeDomCfg()	0	13	1
A	makeTableClass()	0	25	6

<?php

namespace JeroenNoten\LaravelAdminLte\Components;

use Illuminate\View\Component;

class Datatable extends Component
{
    /**
     * The table identification (id) attribute. Required in order to manage
     * the internal or external (JS) initialization.
     *
     * @var string
     */
    public $id;

    /**
     * An array with the set of headers (titles) for the table columns. Each
     * header can be a string or an array with next properties: label, width
     * and no-export.
     *
     * @var array
     */
    public $heads;

    /**
     * The table theme (light, dark, primary, secondary, info, warning or
     * danger).
     *
     * @var string
     */
    public $theme;

    /**
     * The table head theme (light or dark).
     *
     * @var string
     */
    public $headTheme;

    /**
     * The datatables plugin configuration parameters. Array with key => value
     * pairs, where the key should be an existing configuration property of
     * the datatables plugin.
     *
     * @var array
     */
    public $config;

    /**
     * Enables a footer with header cells. The footer can be fully customized
     * using the 'footerCallback' option of the plugin.
     *
     * @var mixed
     */
    public $withFooter;

    /**
     * The table footer theme (light or dark).
     *
     * @var string
     */
    public $footerTheme;

    /**
     * When enabled, borders will be displayed around the table.
     *
     * @var mixed
     */
    public $bordered;

    /**
     * When enabled, a hover effect will be available for the table rows.
     *
     * @var mixed
     */
    public $hoverable;

    /**
     * When enabled, a striped effect will be available for the table rows.
     *
     * @var mixed
     */
    public $striped;

    /**
     * When enabled, the table will be compressed using less white space between
     * cells and rows.
     *
     * @var mixed
     */
    public $compressed;

    /**
     * When enabled, the table cells will be vertically and horizontally
     * centered.
     *
     * @var mixed
     */
    public $beautify;

    /**
     * When enabled, a set of tool buttons for export the table will be
     * displayed.
     *
     * @var mixed
     */
    public $withButtons;

    /**
     * Create a new component instance.
     *
     * @return void
     */
    public function __construct(
        $id, $heads, $theme = null, $headTheme = null, $bordered = null,
        $hoverable = null, $striped = null, $compressed = null,
        $withFooter = null, $footerTheme = null, $beautify = null,
        $withButtons = null, $config = []
    ) {
        $this->id = $id;
        $this->heads = $heads;
        $this->theme = $theme;
        $this->headTheme = $headTheme;
        $this->bordered = $bordered;
        $this->hoverable = $hoverable;
        $this->striped = $striped;
        $this->compressed = $compressed;
        $this->withFooter = $withFooter;
        $this->footerTheme = $footerTheme;
        $this->beautify = $beautify;
        $this->withButtons = $withButtons;

        $this->config = is_array($config) ? $config : [];

        // When buttons are enabled, change the default table layout.

        if (isset($withButtons) && ! isset($this->config['dom'])) {
            $this->config['dom'] = $this->makeDomCfg();
        }

        // When buttons are enabled, setup the set of visible buttons and they
        // default style.

        if (isset($withButtons) && ! isset($this->config['buttons'])) {
            $this->config['buttons'] = $this->makeButtonsCfg();
        }
    }

    /**
     * Make the table class.
     *
     * @return string
     */
    public function makeTableClass()
    {
        $classes = ['table'];

        if (isset($this->bordered)) {
            $classes[] = 'table-bordered';
        }

        if (isset($this->hoverable)) {
            $classes[] = 'table-hover';
        }

        if (isset($this->striped)) {
            $classes[] = 'table-striped';
        }

        if (isset($this->compressed)) {
            $classes[] = 'table-sm';
        }

        if (isset($this->theme)) {
            $classes[] = "table-{$this->theme}";
        }

        return implode(' ', $classes);
    }

    /**
     * Make the Datatables 'dom' configuration with the buttons extension.
     *
     * @return string
     */
    protected function makeDomCfg()
    {
        // Give bootstrap style to table elements.
        // The built-in table control elements in DataTables are:
        // l - Length changing input control.
        // f - Filtering input.
        // t - The table!
        // i - Table information summary.
        // p - Pagination control.
        // r - Processing display element.
        // B - buttons extension.

        return '<"row" <"col-sm-6" B> <"col-sm-6" f> >
                <"row" <"col-12" tr> >
                <"row" <"col-sm-5" i> <"col-sm-7" p> >';
    }

    /**
     * Make the Datatables 'buttons' configuration object to define the set of
     * visible buttons and they style.
     *
     * @return array
     */
    protected function makeButtonsCfg()
    {
        // Configure the export columns selector. We are not going to export
        // columns that explicitly have the 'dt-no-export' attribute.

        $colSelector = ':not([dt-no-export])';

        // Button to change the page length of tables.

        $lengthBtn = [
            'extend' => 'pageLength',
            'className' => 'btn-default',
        ];

        // Button to print the data.

        $printBtn = [
            'extend' => 'print',
            'className' => 'btn-default',
            'text' => '<i class="fas fa-fw fa-lg fa-print"></i>',
            'titleAttr' => 'Print',
            'exportOptions' => ['columns' => $colSelector],
        ];

        // Button to export data to CSV file.

        $csvBtn = [
            'extend' => 'csv',
            'className' => 'btn-default',
            'text' => '<i class="fas fa-fw fa-lg fa-file-csv text-primary"></i>',
            'titleAttr' => 'Export to CSV',
            'exportOptions' => ['columns' => $colSelector],
        ];

        // Button to export data to Excel file.

        $excelBtn = [
            'extend' => 'excel',
            'className' => 'btn-default',
            'text' => '<i class="fas fa-fw fa-lg fa-file-excel text-success"></i>',
            'titleAttr' => 'Export to Excel',
            'exportOptions' => ['columns' => $colSelector],
        ];

        // Button to export data to PDF file.

        $pdfBtn = [
            'extend' => 'pdf',
            'className' => 'btn-default',
            'text' => '<i class="fas fa-fw fa-lg fa-file-pdf text-danger"></i>',
            'titleAttr' => 'Export to PDF',
            'exportOptions' => ['columns' => $colSelector],
        ];

        // Return the set of configured buttons.

        return [
            'dom' => ['button' => ['className' => 'btn']],
            'buttons' => [$lengthBtn, $printBtn, $csvBtn, $excelBtn, $pdfBtn],
        ];
    }

    /**
     * Get the view / contents that represent the component.
     *
     * @return \Illuminate\View\View|string
     */
    public function render()
    {
        return view('adminlte::components.datatable');
    }
}