AbstractExporter - Code Metrics - Inspection of "Adding ID to form groups for custom functions" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1281)

unknown

created 2017-10-03 02:35 UTC

AbstractExporter A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	0
loc	96
rs	10
c	0
b	0
f	0
wmc	10
lcom	1
cbo	4

7 Methods

Rating	Name	Size	Complexity
A	__construct()	6	2
A	setGrid()	6	1
A	getTable()	4	1
A	getData()	4	1
A	chunk()	4	1
A	withScope()	19	4
	export()	1	?

<?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.
     *
     * @return array
     */
    public function getData()
    {
        return $this->grid->getFilter()->execute();
    }

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

    /**
     * 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			* @return array
54			*/
55			public function getData()
56			{
57			return $this->grid->getFilter()->execute();
58			}
59
60			/**
61			* @param callable $callback
62			* @param int $count
63			*
64			* @return bool
65			*/
66			public function chunk(callable $callback, $count = 100)
67			{
68			return $this->grid->getFilter()->chunk($callback, $count);
69			}
70
71			/**
72			* Export data with scope.
73			*
74			* @param string $scope
75			*
76			* @return $this
77			*/
78			public function withScope($scope)
79			{
80			if ($scope == Grid\Exporter::SCOPE_ALL) {
81			return $this;
82			}
83
84			list($scope, $args) = explode(':', $scope);
85
86			if ($scope == Grid\Exporter::SCOPE_CURRENT_PAGE) {
87			$this->grid->model()->usePaginate(true);
88			}
89
90			if ($scope == Grid\Exporter::SCOPE_SELECTED_ROWS) {
91			$selected = explode(',', $args);
92			$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...
93			}
94
95			return $this;
96			}
97
98			/**
99			* {@inheritdoc}
100			*/
101			abstract public function export();
102			}
103

z-song / laravel-admin

Pull Request — master (#1281)

AbstractExporter A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like