AbstractExporter::getQuery() - Code Metrics - Inspection of "Enhance the excel export feature of model-grid" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 942e44...03fbcf )

by Song

created 2019-04-11 10:04 UTC

AbstractExporter::getQuery() A

↳ Parent: AbstractExporter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Encore\Admin\Grid\Exporters;

use Encore\Admin\Grid;

abstract class AbstractExporter implements ExporterInterface
{
    /**
     * @var \Encore\Admin\Grid
     */
    protected $grid;

    /**
     * Create a new exporter instance.
     *
     * @param $grid
     */
    public function __construct(Grid $grid = null)
    {
        if ($grid) {
            $this->setGrid($grid);
        }
    }

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

        return $this;
    }

    /**
     * Get table of grid.
     *
     * @return string
     */
    public function getTable()
    {
        return $this->grid->model()->eloquent()->getTable();
    }

    /**
     * Get data with export query.
     *
     * @param bool $toArray
     *
     * @return array|\Illuminate\Support\Collection|mixed
     */
    public function getData($toArray = true)
    {
        return $this->grid->getFilter()->execute($toArray);
    }

    /**
     * @param callable $callback
     * @param int      $count
     *
     * @return bool
     */
    public function chunk(callable $callback, $count = 100)
    {
        return $this->grid->getFilter()->chunk($callback, $count);
    }

    /**
     * @return \Illuminate\Support\Collection
     */
    public function getCollection()
    {
        return collect($this->getData());
    }

    /**
     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Model
     */
    public function getQuery()
    {
        return $this->grid->getFilter()->getModel()->getQueryBuilder();
    }

    /**
     * Export data with scope.
     *
     * @param string $scope
     *
     * @return $this
     */
    public function withScope($scope)
    {
        if ($scope == Grid\Exporter::SCOPE_ALL) {
            return $this;
        }

        list($scope, $args) = explode(':', $scope);

        if ($scope == Grid\Exporter::SCOPE_CURRENT_PAGE) {
            $this->grid->model()->usePaginate(true);
        }

        if ($scope == Grid\Exporter::SCOPE_SELECTED_ROWS) {
            $selected = explode(',', $args);
            $this->grid->model()->whereIn($this->grid->getKeyName(), $selected);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    abstract public function export();
}


1			<?php
2
3			namespace Encore\Admin\Grid\Exporters;
4
5			use Encore\Admin\Grid;
6
7			abstract class AbstractExporter implements ExporterInterface
8			{
9			/**
10			* @var \Encore\Admin\Grid
11			*/
12			protected $grid;
13
14			/**
15			* Create a new exporter instance.
16			*
17			* @param $grid
18			*/
19			public function __construct(Grid $grid = null)
20			{
21			if ($grid) {
22			$this->setGrid($grid);
23			}
24			}
25
26			/**
27			* Set grid for exporter.
28			*
29			* @param Grid $grid
30			*
31			* @return $this
32			*/
33			public function setGrid(Grid $grid)
34			{
35			$this->grid = $grid;
36
37			return $this;
38			}
39
40			/**
41			* Get table of grid.
42			*
43			* @return string
44			*/
45			public function getTable()
46			{
47			return $this->grid->model()->eloquent()->getTable();
48			}
49
50			/**
51			* Get data with export query.
52			*
53			* @param bool $toArray
54			*
55			* @return array\|\Illuminate\Support\Collection\|mixed
56			*/
57			public function getData($toArray = true)
58			{
59			return $this->grid->getFilter()->execute($toArray);
60			}
61
62			/**
63			* @param callable $callback
64			* @param int $count
65			*
66			* @return bool
67			*/
68			public function chunk(callable $callback, $count = 100)
69			{
70			return $this->grid->getFilter()->chunk($callback, $count);
71			}
72
73			/**
74			* @return \Illuminate\Support\Collection
75			*/
76			public function getCollection()
77			{
78			return collect($this->getData());
79			}
80
81			/**
82			* @return \Illuminate\Database\Eloquent\Builder\|\Illuminate\Database\Eloquent\Model
83			*/
84			public function getQuery()
85			{
86			return $this->grid->getFilter()->getModel()->getQueryBuilder();
87			}
88
89			/**
90			* Export data with scope.
91			*
92			* @param string $scope
93			*
94			* @return $this
95			*/
96			public function withScope($scope)
97			{
98			if ($scope == Grid\Exporter::SCOPE_ALL) {
99			return $this;
100			}
101
102			list($scope, $args) = explode(':', $scope);
103
104			if ($scope == Grid\Exporter::SCOPE_CURRENT_PAGE) {
105			$this->grid->model()->usePaginate(true);
106			}
107
108			if ($scope == Grid\Exporter::SCOPE_SELECTED_ROWS) {
109			$selected = explode(',', $args);
110			$this->grid->model()->whereIn($this->grid->getKeyName(), $selected);
			0 ignored issues – show Documentation Bug introduced 2017-09-01 02:27 UTC by Report Bug Copy Issue Report The method `whereIn` does not exist on `object<Encore\Admin\Grid\Model>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
111			}
112
113			return $this;
114			}
115
116			/**
117			* {@inheritdoc}
118			*/
119			abstract public function export();
120			}
121

z-song / laravel-admin

Push — master ( 942e44...03fbcf )

AbstractExporter::getQuery() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like