Encore\Admin\Grid\Concerns\CanExportGrid

Complexity

Total Complexity

13

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	handleExportRequest()	0	17	4
A	getExporter()	0	4	1
A	exporter()	0	6	1
A	getExportUrl()	0	10	2
A	showExportBtn()	0	4	1
A	disableExport()	0	4	1
A	renderExportButton()	0	4	1
A	export()	0	10	2

<?php

namespace Encore\Admin\Grid\Concerns;

use Encore\Admin\Grid;
use Encore\Admin\Grid\Column;
use Encore\Admin\Grid\Exporter;
use Encore\Admin\Grid\Exporters\AbstractExporter;

trait CanExportGrid
{
    /**
     * Export driver.
     *
     * @var string
     */
    protected $exporter;

    /**
     * Handle export request.
     *
     * @param bool $forceExport
     */
    protected function handleExportRequest($forceExport = false)
    {
        if (!$scope = request(Exporter::$queryName)) {
            return;
        }

        // clear output buffer.
        if (ob_get_length()) {
            ob_end_clean();
        }

        $this->disablePagination();

It seems like disablePagination() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if ($forceExport) {
            $this->getExporter($scope)->export();
        }
    }

    /**
     * @param string $scope
     *
     * @return AbstractExporter
     */
    protected function getExporter($scope)
    {
        return (new Exporter($this))->resolve($this->exporter)->withScope($scope);
    }

    /**
     * Set exporter driver for Grid to export.
     *
     * @param $exporter
     *
     * @return $this
     */
    public function exporter($exporter)
    {
        $this->exporter = $exporter;

        return $this;
    }

    /**
     * Get the export url.
     *
     * @param int $scope
     * @param null $args
     *
     * @return string
     */
    public function getExportUrl($scope = 1, $args = null)
    {
        $input = array_merge(request()->all(), Exporter::formatExportQuery($scope, $args));

        if ($constraints = $this->model()->getConstraints()) {

It seems like model() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $input = array_merge($input, $constraints);
        }

        return $this->resource() . '?' . http_build_query($input);

It seems like resource() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * If grid show export btn.
     *
     * @return bool
     */
    public function showExportBtn()
    {
        return $this->option('show_exporter');

It seems like option() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Disable export.
     *
     * @return $this
     */
    public function disableExport(bool $disable = true)
    {
        return $this->option('show_exporter', !$disable);

It seems like option() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Render export button.
     *
     * @return string
     */
    public function renderExportButton()
    {
        return (new Grid\Tools\ExportButton($this))->render();
    }

    /**
     * @param \Closure $callback
     */
    public function export(\Closure $callback)
    {
        if (!$scope = request(Exporter::$queryName)) {
            return;
        }

        $this->getExporter($scope)->setCallback($callback);

        return $this;
    }
}