DataTable::html() - Code Metrics - yajra/laravel-datatables-buttons - Measure and Improve Code Quality continuously with Scrutinizer

DataTable::html() A
last analyzed 2020-09-09 05:28 UTC

↳ Parent: DataTable

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Yajra\DataTables\Services;

use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
use Yajra\DataTables\Contracts\DataTableButtons;
use Yajra\DataTables\Contracts\DataTableScope;
use Yajra\DataTables\Html\Column;
use Yajra\DataTables\Transformers\DataArrayTransformer;

abstract class DataTable implements DataTableButtons
{
    /**
     * DataTables print preview view.
     *
     * @var string
     */
    protected $printPreview = 'datatables::print';

    /**
     * Name of the dataTable variable.
     *
     * @var string
     */
    protected $dataTableVariable = 'dataTable';

    /**
     * List of columns to be excluded from export.
     *
     * @var string|array
     */
    protected $excludeFromExport = [];

    /**
     * List of columns to be excluded from printing.
     *
     * @var string|array
     */
    protected $excludeFromPrint = [];

    /**
     * List of columns to be exported.
     *
     * @var string|array
     */
    protected $exportColumns = '*';

    /**
     * List of columns to be printed.
     *
     * @var string|array
     */
    protected $printColumns = '*';

    /**
     * Query scopes.
     *
     * @var \Yajra\DataTables\Contracts\DataTableScope[]
     */
    protected $scopes = [];

    /**
     * Html builder.
     *
     * @var \Yajra\DataTables\Html\Builder
     */
    protected $htmlBuilder;

    /**
     * Html builder extension callback.
     *
     * @var callable
     */
    protected $htmlCallback;

    /**
     * Export filename.
     *
     * @var string
     */
    protected $filename = '';

    /**
     * Custom attributes set on the class.
     *
     * @var array
     */
    protected $attributes = [];

    /**
     * Callback before sending the response.
     *
     * @var callable
     */
    protected $beforeCallback;

    /**
     * Callback after processing the response.
     *
     * @var callable
     */
    protected $responseCallback;

    /**
     * Available button actions. When calling an action, the value will be used
     * as the function name (so it should be available)
     * If you want to add or disable an action, overload and modify this property.
     *
     * @var array
     */
    protected $actions = ['print', 'csv', 'excel', 'pdf'];

    /**
     * @var \Yajra\DataTables\Utilities\Request
     */
    protected $request;

    /**
     * Export class handler.
     *
     * @var string
     */
    protected $exportClass = DataTablesExportHandler::class;

    /**
     * CSV export type writer.
     *
     * @var string
     */
    protected $csvWriter = 'Csv';

    /**
     * Excel export type writer.
     *
     * @var string
     */
    protected $excelWriter = 'Xlsx';

    /**
     * PDF export type writer.
     *
     * @var string
     */
    protected $pdfWriter = 'Dompdf';

    /**
     * Process dataTables needed render output.
     *
     * @param string $view
     * @param array $data
     * @param array $mergeData
     * @return mixed
     */
    public function render($view, $data = [], $mergeData = [])
    {
        if ($this->request()->ajax() && $this->request()->wantsJson()) {
            return app()->call([$this, 'ajax']);
        }

        if ($action = $this->request()->get('action') and in_array($action, $this->actions)) {
            if ($action == 'print') {
                return app()->call([$this, 'printPreview']);
            }

            return app()->call([$this, $action]);
        }

        return view($view, $data, $mergeData)->with($this->dataTableVariable, $this->getHtmlBuilder());
    }

    /**
     * Get DataTables Request instance.
     *
     * @return \Yajra\DataTables\Utilities\Request
     */
    public function request()
    {
        return $this->request ?: $this->request = app('datatables.request');
    }

    /**
     * Display ajax response.
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function ajax()
    {
        $query = null;
        if (method_exists($this, 'query')) {
            $query = app()->call([$this, 'query']);
            $query = $this->applyScopes($query);
        }

        /** @var \Yajra\DataTables\DataTableAbstract $dataTable */
        $dataTable = app()->call([$this, 'dataTable'], compact('query'));

        if ($callback = $this->beforeCallback) {
            $callback($dataTable);
        }

        if ($callback = $this->responseCallback) {
            $data = new Collection($dataTable->toArray());

            return new JsonResponse($callback($data));
        }

        return $dataTable->toJson();
    }

    /**
     * Display printable view of datatables.
     *
     * @return \Illuminate\Contracts\View\View
     */
    public function printPreview()
    {
        $data = $this->getDataForPrint();

        return view($this->printPreview, compact('data'));
    }

    /**
     * Get mapped columns versus final decorated output.
     *
     * @return array
     */
    protected function getDataForPrint()
    {
        $columns = $this->printColumns();

        return $this->mapResponseToColumns($columns, 'printable');
    }

    /**
     * Get printable columns.
     *
     * @return array|string
     */
    protected function printColumns()
    {
        return is_array($this->printColumns) ? $this->toColumnsCollection($this->printColumns) : $this->getPrintColumnsFromBuilder();
    }

    /**
     * Get filtered print columns definition from html builder.
     *
     * @return \Illuminate\Support\Collection
     */
    protected function getPrintColumnsFromBuilder()
    {
        return $this->html()->removeColumn(...$this->excludeFromPrint)->getColumns();
    }

    /**
     * Get filtered export columns definition from html builder.
     *
     * @return \Illuminate\Support\Collection
     */
    protected function getExportColumnsFromBuilder()
    {
        return $this->html()->removeColumn(...$this->excludeFromExport)->getColumns();
    }

    /**
     * Get columns definition from html builder.
     *
     * @return \Illuminate\Support\Collection
     */
    protected function getColumnsFromBuilder()
    {
        return $this->html()->getColumns();
    }

    /**
     * Optional method if you want to use html builder.
     *
     * @return \Yajra\DataTables\Html\Builder
     */
    public function html()
    {
        return $this->builder();
    }

    /**
     * Get DataTables Html Builder instance.
     *
     * @return \Yajra\DataTables\Html\Builder
     */
    public function builder()
    {
        if ($this->htmlBuilder) {
            return $this->htmlBuilder;
        }

        if (method_exists($this, 'htmlBuilder')) {
            return $this->htmlBuilder = app()->call([$this, 'htmlBuilder']);
        }

        return $this->htmlBuilder = app('datatables.html');
    }

    /**
     * Map ajax response to columns definition.
     *
     * @param mixed $columns
     * @param string $type
     * @return array
     */
    protected function mapResponseToColumns($columns, $type)
    {
        $transformer = new DataArrayTransformer;

        return array_map(function ($row) use ($columns, $type, $transformer) {
            return $transformer->transform($row, $columns, $type);
        }, $this->getAjaxResponseData());
    }

    /**
     * Get decorated data as defined in datatables ajax response.
     *
     * @return array
     */
    protected function getAjaxResponseData()
    {
        $this->request()->merge(['length' => -1]);

        $response = app()->call([$this, 'ajax']);
        $data     = $response->getData(true);

        return $data['data'];
    }

    /**
     * @return \Yajra\DataTables\Html\Builder
     */
    protected function getHtmlBuilder()
    {
        $builder = $this->html();
        if ($this->htmlCallback) {
            call_user_func($this->htmlCallback, $builder);
        }

        return $builder;
    }

    /**
     * Add html builder callback hook.
     *
     * @param callable $callback
     * @return $this
     */
    public function withHtml(callable $callback)
    {
        $this->htmlCallback = $callback;

        return $this;
    }

    /**
     * Add callback before sending the response.
     *
     * @param callable $callback
     * @return $this
     */
    public function before(callable $callback)
    {
        $this->beforeCallback = $callback;

        return $this;
    }

    /**
     * Add callback after the response was processed.
     *
     * @param callable $callback
     * @return $this
     */
    public function response(callable $callback)
    {
        $this->responseCallback = $callback;

        return $this;
    }

    /**
     * Export results to Excel file.
     *
     * @return void
     */
    public function excel()
    {
        $ext = '.' . strtolower($this->excelWriter);

        return $this->buildExcelFile()->download($this->getFilename() . $ext, $this->excelWriter);
    }

    /**
     * Build excel file and prepare for export.
     *
     * @return \Maatwebsite\Excel\Concerns\Exportable

     */
    protected function buildExcelFile()
    {
        $dataForExport = collect($this->getDataForExport());

        return new $this->exportClass($dataForExport);
    }

    /**
     * Get export filename.
     *
     * @return string
     */
    public function getFilename()
    {
        return $this->filename ?: $this->filename();
    }

    /**
     * Set export filename.
     *
     * @param string $filename
     * @return DataTable
     */
    public function setFilename($filename)
    {
        $this->filename = $filename;

        return $this;
    }

    /**
     * Get filename for export.
     *
     * @return string
     */
    protected function filename()
    {
        return class_basename($this) . '_' . date('YmdHis');
    }

    /**
     * Get mapped columns versus final decorated output.
     *
     * @return array
     */
    protected function getDataForExport()
    {
        $columns = $this->exportColumns();

        return $this->mapResponseToColumns($columns, 'exportable');
    }

    /**
     * Get export columns definition.
     *
     * @return array|string
     */
    private function exportColumns()
    {
        return is_array($this->exportColumns) ? $this->toColumnsCollection($this->exportColumns) : $this->getExportColumnsFromBuilder();
    }

    /**
     * Convert array to collection of Column class.
     *
     * @param array $columns
     * @return Collection
     */
    private function toColumnsCollection(array $columns)
    {
        $collection = collect();
        foreach ($columns as $column) {
            if (isset($column['data'])) {
                $column['title'] = $column['title'] ?? $column['data'];
                $collection->push(new Column($column));
            } else {
                $data          = [];
                $data['data']  = $column;
                $data['title'] = $column;
                $collection->push(new Column($data));
            }
        }

        return $collection;
    }

    /**
     * Export results to CSV file.
     *
     * @return mixed
     */
    public function csv()
    {
        $ext = '.' . strtolower($this->csvWriter);

        return $this->buildExcelFile()->download($this->getFilename() . $ext, $this->csvWriter);
    }

    /**
     * Export results to PDF file.
     *
     * @return mixed
     */
    public function pdf()
    {
        if ('snappy' == config('datatables-buttons.pdf_generator', 'snappy')) {
            return $this->snappyPdf();
        }

        return $this->buildExcelFile()->download($this->getFilename() . '.pdf', $this->pdfWriter);
    }

    /**
     * PDF version of the table using print preview blade template.
     *
     * @return mixed
     */
    public function snappyPdf()
    {
        /** @var \Barryvdh\Snappy\PdfWrapper $snappy */
        $snappy      = app('snappy.pdf.wrapper');
        $options     = config('datatables-buttons.snappy.options');
        $orientation = config('datatables-buttons.snappy.orientation');

        $snappy->setOptions($options)->setOrientation($orientation);

        return $snappy->loadHTML($this->printPreview())->download($this->getFilename() . '.pdf');
    }

    /**
     * Add basic array query scopes.
     *
     * @param \Yajra\DataTables\Contracts\DataTableScope $scope
     * @return $this
     */
    public function addScope(DataTableScope $scope)
    {
        $this->scopes[] = $scope;

        return $this;
    }

    /**
     * Push multiples scopes to array query scopes.
     *
     * @param array $scopes
     * @return $this
     */
    public function addScopes(array $scopes)
    {
        array_push($this->scopes, $scopes);

        return $this;
    }

    /**
     * Set a custom class attribute.
     *
     * @param mixed $key
     * @param mixed|null $value
     * @return $this
     */
    public function with($key, $value = null)
    {
        if (is_array($key)) {
            $this->attributes = array_merge($this->attributes, $key);
        } else {
            $this->attributes[$key] = $value;
        }

        return $this;
    }

    /**
     * Dynamically retrieve the value of an attribute.
     *
     * @param string $key
     * @return mixed|null
     */
    public function __get($key)
    {
        if (array_key_exists($key, $this->attributes)) {
            return $this->attributes[$key];
        }
    }

    /**
     * Apply query scopes.
     *
     * @param \Illuminate\Database\Query\Builder|\Illuminate\Database\Eloquent\Builder $query
     * @return mixed
     */
    protected function applyScopes($query)
    {
        foreach ($this->scopes as $scope) {
            $scope->apply($query);
        }

        return $query;
    }

    /**
     * Determine if the DataTable has scopes.
     *
     * @param  array $scopes
     * @param  bool $validateAll
     * @return bool
     */
    protected function hasScopes(array $scopes, $validateAll = false)
    {
        $filteredScopes = array_filter($this->scopes, function ($scope) use ($scopes) {
            return in_array(get_class($scope), $scopes);
        });

        return $validateAll ? count($filteredScopes) === count($scopes) : ! empty($filteredScopes);
    }

    /**
     * Get default builder parameters.
     *
     * @return array
     */
    protected function getBuilderParameters()
    {
        return config('datatables-buttons.parameters');
    }
}


1			<?php
2
3			namespace Yajra\DataTables\Services;
4
5			use Illuminate\Http\JsonResponse;
6			use Illuminate\Support\Collection;
7			use Yajra\DataTables\Contracts\DataTableButtons;
8			use Yajra\DataTables\Contracts\DataTableScope;
9			use Yajra\DataTables\Html\Column;
10			use Yajra\DataTables\Transformers\DataArrayTransformer;
11
12			abstract class DataTable implements DataTableButtons
13			{
14			/**
15			* DataTables print preview view.
16			*
17			* @var string
18			*/
19			protected $printPreview = 'datatables::print';
20
21			/**
22			* Name of the dataTable variable.
23			*
24			* @var string
25			*/
26			protected $dataTableVariable = 'dataTable';
27
28			/**
29			* List of columns to be excluded from export.
30			*
31			* @var string\|array
32			*/
33			protected $excludeFromExport = [];
34
35			/**
36			* List of columns to be excluded from printing.
37			*
38			* @var string\|array
39			*/
40			protected $excludeFromPrint = [];
41
42			/**
43			* List of columns to be exported.
44			*
45			* @var string\|array
46			*/
47			protected $exportColumns = '*';
48
49			/**
50			* List of columns to be printed.
51			*
52			* @var string\|array
53			*/
54			protected $printColumns = '*';
55
56			/**
57			* Query scopes.
58			*
59			* @var \Yajra\DataTables\Contracts\DataTableScope[]
60			*/
61			protected $scopes = [];
62
63			/**
64			* Html builder.
65			*
66			* @var \Yajra\DataTables\Html\Builder
67			*/
68			protected $htmlBuilder;
69
70			/**
71			* Html builder extension callback.
72			*
73			* @var callable
74			*/
75			protected $htmlCallback;
76
77			/**
78			* Export filename.
79			*
80			* @var string
81			*/
82			protected $filename = '';
83
84			/**
85			* Custom attributes set on the class.
86			*
87			* @var array
88			*/
89			protected $attributes = [];
90
91			/**
92			* Callback before sending the response.
93			*
94			* @var callable
95			*/
96			protected $beforeCallback;
97
98			/**
99			* Callback after processing the response.
100			*
101			* @var callable
102			*/
103			protected $responseCallback;
104
105			/**
106			* Available button actions. When calling an action, the value will be used
107			* as the function name (so it should be available)
108			* If you want to add or disable an action, overload and modify this property.
109			*
110			* @var array
111			*/
112			protected $actions = ['print', 'csv', 'excel', 'pdf'];
113
114			/**
115			* @var \Yajra\DataTables\Utilities\Request
116			*/
117			protected $request;
118
119			/**
120			* Export class handler.
121			*
122			* @var string
123			*/
124			protected $exportClass = DataTablesExportHandler::class;
125
126			/**
127			* CSV export type writer.
128			*
129			* @var string
130			*/
131			protected $csvWriter = 'Csv';
132
133			/**
134			* Excel export type writer.
135			*
136			* @var string
137			*/
138			protected $excelWriter = 'Xlsx';
139
140			/**
141			* PDF export type writer.
142			*
143			* @var string
144			*/
145			protected $pdfWriter = 'Dompdf';
146
147			/**
148			* Process dataTables needed render output.
149			*
150			* @param string $view
151			* @param array $data
152			* @param array $mergeData
153			* @return mixed
154			*/
155			public function render($view, $data = [], $mergeData = [])
156			{
157			if ($this->request()->ajax() && $this->request()->wantsJson()) {
158			return app()->call([$this, 'ajax']);
159			}
160
161			if ($action = $this->request()->get('action') and in_array($action, $this->actions)) {
162			if ($action == 'print') {
163			return app()->call([$this, 'printPreview']);
164			}
165
166			return app()->call([$this, $action]);
167			}
168
169			return view($view, $data, $mergeData)->with($this->dataTableVariable, $this->getHtmlBuilder());
170			}
171
172			/**
173			* Get DataTables Request instance.
174			*
175			* @return \Yajra\DataTables\Utilities\Request
176			*/
177			public function request()
178			{
179			return $this->request ?: $this->request = app('datatables.request');
180			}
181
182			/**
183			* Display ajax response.
184			*
185			* @return \Illuminate\Http\JsonResponse
186			*/
187			public function ajax()
188			{
189			$query = null;
190			if (method_exists($this, 'query')) {
191			$query = app()->call([$this, 'query']);
192			$query = $this->applyScopes($query);
193			}
194
195			/** @var \Yajra\DataTables\DataTableAbstract $dataTable */
196			$dataTable = app()->call([$this, 'dataTable'], compact('query'));
197
198			if ($callback = $this->beforeCallback) {
199			$callback($dataTable);
200			}
201
202			if ($callback = $this->responseCallback) {
203			$data = new Collection($dataTable->toArray());
204
205			return new JsonResponse($callback($data));
206			}
207
208			return $dataTable->toJson();
209			}
210
211			/**
212			* Display printable view of datatables.
213			*
214			* @return \Illuminate\Contracts\View\View
215			*/
216			public function printPreview()
217			{
218			$data = $this->getDataForPrint();
219
220			return view($this->printPreview, compact('data'));
221			}
222
223			/**
224			* Get mapped columns versus final decorated output.
225			*
226			* @return array
227			*/
228			protected function getDataForPrint()
229			{
230			$columns = $this->printColumns();
231
232			return $this->mapResponseToColumns($columns, 'printable');
233			}
234
235			/**
236			* Get printable columns.
237			*
238			* @return array\|string
239			*/
240			protected function printColumns()
241			{
242			return is_array($this->printColumns) ? $this->toColumnsCollection($this->printColumns) : $this->getPrintColumnsFromBuilder();
243			}
244
245			/**
246			* Get filtered print columns definition from html builder.
247			*
248			* @return \Illuminate\Support\Collection
249			*/
250			protected function getPrintColumnsFromBuilder()
251			{
252			return $this->html()->removeColumn(...$this->excludeFromPrint)->getColumns();
253			}
254
255			/**
256			* Get filtered export columns definition from html builder.
257			*
258			* @return \Illuminate\Support\Collection
259			*/
260			protected function getExportColumnsFromBuilder()
261			{
262			return $this->html()->removeColumn(...$this->excludeFromExport)->getColumns();
263			}
264
265			/**
266			* Get columns definition from html builder.
267			*
268			* @return \Illuminate\Support\Collection
269			*/
270			protected function getColumnsFromBuilder()
271			{
272			return $this->html()->getColumns();
273			}
274
275			/**
276			* Optional method if you want to use html builder.
277			*
278			* @return \Yajra\DataTables\Html\Builder
279			*/
280			public function html()
281			{
282			return $this->builder();
283			}
284
285			/**
286			* Get DataTables Html Builder instance.
287			*
288			* @return \Yajra\DataTables\Html\Builder
289			*/
290			public function builder()
291			{
292			if ($this->htmlBuilder) {
293			return $this->htmlBuilder;
294			}
295
296			if (method_exists($this, 'htmlBuilder')) {
297			return $this->htmlBuilder = app()->call([$this, 'htmlBuilder']);
298			}
299
300			return $this->htmlBuilder = app('datatables.html');
301			}
302
303			/**
304			* Map ajax response to columns definition.
305			*
306			* @param mixed $columns
307			* @param string $type
308			* @return array
309			*/
310			protected function mapResponseToColumns($columns, $type)
311			{
312			$transformer = new DataArrayTransformer;
313
314			return array_map(function ($row) use ($columns, $type, $transformer) {
315			return $transformer->transform($row, $columns, $type);
316			}, $this->getAjaxResponseData());
317			}
318
319			/**
320			* Get decorated data as defined in datatables ajax response.
321			*
322			* @return array
323			*/
324			protected function getAjaxResponseData()
325			{
326			$this->request()->merge(['length' => -1]);
327
328			$response = app()->call([$this, 'ajax']);
329			$data = $response->getData(true);
330
331			return $data['data'];
332			}
333
334			/**
335			* @return \Yajra\DataTables\Html\Builder
336			*/
337			protected function getHtmlBuilder()
338			{
339			$builder = $this->html();
340			if ($this->htmlCallback) {
341			call_user_func($this->htmlCallback, $builder);
342			}
343
344			return $builder;
345			}
346
347			/**
348			* Add html builder callback hook.
349			*
350			* @param callable $callback
351			* @return $this
352			*/
353			public function withHtml(callable $callback)
354			{
355			$this->htmlCallback = $callback;
356
357			return $this;
358			}
359
360			/**
361			* Add callback before sending the response.
362			*
363			* @param callable $callback
364			* @return $this
365			*/
366			public function before(callable $callback)
367			{
368			$this->beforeCallback = $callback;
369
370			return $this;
371			}
372
373			/**
374			* Add callback after the response was processed.
375			*
376			* @param callable $callback
377			* @return $this
378			*/
379			public function response(callable $callback)
380			{
381			$this->responseCallback = $callback;
382
383			return $this;
384			}
385
386			/**
387			* Export results to Excel file.
388			*
389			* @return void
390			*/
391			public function excel()
392			{
393			$ext = '.' . strtolower($this->excelWriter);
394
395			return $this->buildExcelFile()->download($this->getFilename() . $ext, $this->excelWriter);
396			}
397
398			/**
399			* Build excel file and prepare for export.
400			*
401			* @return \Maatwebsite\Excel\Concerns\Exportable
			0 ignored issues – show Comprehensibility Bug introduced 2018-03-28 18:05 UTC by Report Bug Copy Issue Report The return type `\Maatwebsite\Excel\Concerns\Exportable` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods. If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly. Loading history...
402			*/
403			protected function buildExcelFile()
404			{
405			$dataForExport = collect($this->getDataForExport());
406
407			return new $this->exportClass($dataForExport);
408			}
409
410			/**
411			* Get export filename.
412			*
413			* @return string
414			*/
415			public function getFilename()
416			{
417			return $this->filename ?: $this->filename();
418			}
419
420			/**
421			* Set export filename.
422			*
423			* @param string $filename
424			* @return DataTable
425			*/
426			public function setFilename($filename)
427			{
428			$this->filename = $filename;
429
430			return $this;
431			}
432
433			/**
434			* Get filename for export.
435			*
436			* @return string
437			*/
438			protected function filename()
439			{
440			return class_basename($this) . '_' . date('YmdHis');
441			}
442
443			/**
444			* Get mapped columns versus final decorated output.
445			*
446			* @return array
447			*/
448			protected function getDataForExport()
449			{
450			$columns = $this->exportColumns();
451
452			return $this->mapResponseToColumns($columns, 'exportable');
453			}
454
455			/**
456			* Get export columns definition.
457			*
458			* @return array\|string
459			*/
460			private function exportColumns()
461			{
462			return is_array($this->exportColumns) ? $this->toColumnsCollection($this->exportColumns) : $this->getExportColumnsFromBuilder();
463			}
464
465			/**
466			* Convert array to collection of Column class.
467			*
468			* @param array $columns
469			* @return Collection
470			*/
471			private function toColumnsCollection(array $columns)
472			{
473			$collection = collect();
474			foreach ($columns as $column) {
475			if (isset($column['data'])) {
476			$column['title'] = $column['title'] ?? $column['data'];
477			$collection->push(new Column($column));
478			} else {
479			$data = [];
480			$data['data'] = $column;
481			$data['title'] = $column;
482			$collection->push(new Column($data));
483			}
484			}
485
486			return $collection;
487			}
488
489			/**
490			* Export results to CSV file.
491			*
492			* @return mixed
493			*/
494			public function csv()
495			{
496			$ext = '.' . strtolower($this->csvWriter);
497
498			return $this->buildExcelFile()->download($this->getFilename() . $ext, $this->csvWriter);
499			}
500
501			/**
502			* Export results to PDF file.
503			*
504			* @return mixed
505			*/
506			public function pdf()
507			{
508			if ('snappy' == config('datatables-buttons.pdf_generator', 'snappy')) {
509			return $this->snappyPdf();
510			}
511
512			return $this->buildExcelFile()->download($this->getFilename() . '.pdf', $this->pdfWriter);
513			}
514
515			/**
516			* PDF version of the table using print preview blade template.
517			*
518			* @return mixed
519			*/
520			public function snappyPdf()
521			{
522			/** @var \Barryvdh\Snappy\PdfWrapper $snappy */
523			$snappy = app('snappy.pdf.wrapper');
524			$options = config('datatables-buttons.snappy.options');
525			$orientation = config('datatables-buttons.snappy.orientation');
526
527			$snappy->setOptions($options)->setOrientation($orientation);
528
529			return $snappy->loadHTML($this->printPreview())->download($this->getFilename() . '.pdf');
530			}
531
532			/**
533			* Add basic array query scopes.
534			*
535			* @param \Yajra\DataTables\Contracts\DataTableScope $scope
536			* @return $this
537			*/
538			public function addScope(DataTableScope $scope)
539			{
540			$this->scopes[] = $scope;
541
542			return $this;
543			}
544
545			/**
546			* Push multiples scopes to array query scopes.
547			*
548			* @param array $scopes
549			* @return $this
550			*/
551			public function addScopes(array $scopes)
552			{
553			array_push($this->scopes, $scopes);
554
555			return $this;
556			}
557
558			/**
559			* Set a custom class attribute.
560			*
561			* @param mixed $key
562			* @param mixed\|null $value
563			* @return $this
564			*/
565			public function with($key, $value = null)
566			{
567			if (is_array($key)) {
568			$this->attributes = array_merge($this->attributes, $key);
569			} else {
570			$this->attributes[$key] = $value;
571			}
572
573			return $this;
574			}
575
576			/**
577			* Dynamically retrieve the value of an attribute.
578			*
579			* @param string $key
580			* @return mixed\|null
581			*/
582			public function __get($key)
583			{
584			if (array_key_exists($key, $this->attributes)) {
585			return $this->attributes[$key];
586			}
587			}
588
589			/**
590			* Apply query scopes.
591			*
592			* @param \Illuminate\Database\Query\Builder\|\Illuminate\Database\Eloquent\Builder $query
593			* @return mixed
594			*/
595			protected function applyScopes($query)
596			{
597			foreach ($this->scopes as $scope) {
598			$scope->apply($query);
599			}
600
601			return $query;
602			}
603
604			/**
605			* Determine if the DataTable has scopes.
606			*
607			* @param array $scopes
608			* @param bool $validateAll
609			* @return bool
610			*/
611			protected function hasScopes(array $scopes, $validateAll = false)
612			{
613			$filteredScopes = array_filter($this->scopes, function ($scope) use ($scopes) {
614			return in_array(get_class($scope), $scopes);
615			});
616
617			return $validateAll ? count($filteredScopes) === count($scopes) : ! empty($filteredScopes);
618			}
619
620			/**
621			* Get default builder parameters.
622			*
623			* @return array
624			*/
625			protected function getBuilderParameters()
626			{
627			return config('datatables-buttons.parameters');
628			}
629			}
630

yajra / laravel-datatables-buttons

DataTable::html() A last analyzed 2020-09-09 05:28 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DataTable::html() A
last analyzed 2020-09-09 05:28 UTC