CsvExporter::filename() - Code Metrics - Inspection of "Grid csv export refactoring" - z-song/laravel-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f09455...266dce )

by Song

created 2020-04-28 09:44 UTC

CsvExporter::filename() A

↳ Parent: CsvExporter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Encore\Admin\Grid\Exporters;

use Encore\Admin\Grid;
use Encore\Admin\Grid\Column;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;

class CsvExporter extends AbstractExporter
{
    /**
     * @var string
     */
    protected $filename;

    /**
     * @var \Closure
     */
    protected $callback;

    /**
     * @var array
     */
    protected $exceptColumns;

    /**
     * @var array
     */
    protected $onlyColumns;

    /**
     * @var []\Closure
     */
    protected $columnCallbacks;

    /**
     * @var array
     */
    protected $visibleColumns;

    /**
     * @var array
     */
    protected $columnUseOriginalValue;

    /**
     * @param string $filename
     * @return $this
     */
    public function filename(string $filename = ''): self
    {
        $this->filename = $filename;

        return $this;
    }

    /**
     * @param \Closure $closure
     */
    public function setCallback(\Closure $closure): self
    {
        $this->callback = $closure;

        return $this;
    }

    /**
     * @param array $columns
     * @return $this
     */
    public function except(array $columns = []): self
    {
        $this->exceptColumns = $columns;

        return $this;
    }

    /**
     * @param array $columns
     * @return $this
     */
    public function only(array $columns = []): self
    {
        $this->onlyColumns = $columns;

        return $this;
    }

    /**
     * @param array $columns
     * @return $this
     */
    public function originalValue($columns = []): self
    {
        $this->columnUseOriginalValue = $columns;

        return $this;
    }

    /**
     * @param string $name
     * @param \Closure $callback
     * @return $this
     */
    public function column(string $name, \Closure $callback): self
    {
        $this->columnCallbacks[$name] = $callback;

        return $this;
    }

    /**
     * Get download response headers.
     *
     * @return array
     */
    protected function getHeaders()
    {
        if (!$this->filename) {
            $this->filename = $this->getTable();
        }

        return [
            'Content-Encoding'    => 'UTF-8',
            'Content-Type'        => 'text/csv;charset=UTF-8',
            'Content-Disposition' => "attachment;filename=\"{$this->filename}.csv\"",
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function export()
    {
        if ($this->callback) {
            call_user_func($this->callback, $this);
        }

        $response = function () {
            $handle = fopen('php://output', 'w');
            $titles = [];

            $this->chunk(function ($collection) use ($handle, &$titles) {

                Column::setOriginalGridModels($collection);

                $original = $current = $collection->toArray();

                $this->grid->getColumns()->map(function (Column $column) use (&$current) {
                    $current                   = $column->fill($current);
                    $this->grid->columnNames[] = $column->getName();
                });

                // Write title
                if (empty($titles)) {
                    fputcsv($handle, $titles = $this->getVisiableTitles());
                }

                // Write rows
                foreach ($current as $index => $record) {
                    fputcsv($handle, $this->getVisiableFields($record, $original[$index]));
                }
            });
            fclose($handle);
        };

        response()->stream($response, 200, $this->getHeaders())->send();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        exit;
    }

    /**
     * @return array
     */
    protected function getVisiableTitles()
    {
        $titles = $this->grid->visibleColumns()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->mapWithKeys(function (Column $column) {
                return [$column->getName() => $column->getLabel()];
            });

        if ($this->onlyColumns) {

            $titles = $titles->only($this->onlyColumns);
        }

        if ($this->exceptColumns) {

            $titles = $titles->except($this->exceptColumns);
        }

        $this->visibleColumns = $titles->keys();

        return $titles->values()->toArray();
    }

    /**
     * @param array $value
     * @param array $original
     * @return array
     */
    public function getVisiableFields(array $value, array $original): array
    {
        $fields = [];

        foreach ($this->visibleColumns as $column) {
            $fields[] = $this->getColumnValue(
                $column,
                data_get($value, $column),
                data_get($original, $column)
            );
        }

        return $fields;
    }

    /**
     * @param string $column
     * @param mixed $value
     * @param mixed $original
     * @return mixed
     */
    protected function getColumnValue(string $column, $value, $original)
    {
        if (!empty($this->columnUseOriginalValue)
            && in_array($column, $this->columnUseOriginalValue)) {
            return $original;
        }

        if (isset($this->columnCallbacks[$column])) {
            return $this->columnCallbacks[$column]($value, $original);
        }

        return $value;
    }
}


Push — master ( f09455...266dce )

CsvExporter::filename() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace Encore\Admin\Grid\Exporters;
4
5			use Encore\Admin\Grid;
6			use Encore\Admin\Grid\Column;
7			use Illuminate\Database\Eloquent\Model;
8			use Illuminate\Support\Arr;
9			use Illuminate\Support\Collection;
10			use Illuminate\Support\Str;
11
12			class CsvExporter extends AbstractExporter
13			{
14			/**
15			* @var string
16			*/
17			protected $filename;
18
19			/**
20			* @var \Closure
21			*/
22			protected $callback;
23
24			/**
25			* @var array
26			*/
27			protected $exceptColumns;
28
29			/**
30			* @var array
31			*/
32			protected $onlyColumns;
33
34			/**
35			* @var []\Closure
36			*/
37			protected $columnCallbacks;
38
39			/**
40			* @var array
41			*/
42			protected $visibleColumns;
43
44			/**
45			* @var array
46			*/
47			protected $columnUseOriginalValue;
48
49			/**
50			* @param string $filename
51			* @return $this
52			*/
53			public function filename(string $filename = ''): self
54			{
55			$this->filename = $filename;
56
57			return $this;
58			}
59
60			/**
61			* @param \Closure $closure
62			*/
63			public function setCallback(\Closure $closure): self
64			{
65			$this->callback = $closure;
66
67			return $this;
68			}
69
70			/**
71			* @param array $columns
72			* @return $this
73			*/
74			public function except(array $columns = []): self
75			{
76			$this->exceptColumns = $columns;
77
78			return $this;
79			}
80
81			/**
82			* @param array $columns
83			* @return $this
84			*/
85			public function only(array $columns = []): self
86			{
87			$this->onlyColumns = $columns;
88
89			return $this;
90			}
91
92			/**
93			* @param array $columns
94			* @return $this
95			*/
96			public function originalValue($columns = []): self
97			{
98			$this->columnUseOriginalValue = $columns;
99
100			return $this;
101			}
102
103			/**
104			* @param string $name
105			* @param \Closure $callback
106			* @return $this
107			*/
108			public function column(string $name, \Closure $callback): self
109			{
110			$this->columnCallbacks[$name] = $callback;
111
112			return $this;
113			}
114
115			/**
116			* Get download response headers.
117			*
118			* @return array
119			*/
120			protected function getHeaders()
121			{
122			if (!$this->filename) {
123			$this->filename = $this->getTable();
124			}
125
126			return [
127			'Content-Encoding' => 'UTF-8',
128			'Content-Type' => 'text/csv;charset=UTF-8',
129			'Content-Disposition' => "attachment;filename=\"{$this->filename}.csv\"",
130			];
131			}
132
133			/**
134			* {@inheritdoc}
135			*/
136			public function export()
137			{
138			if ($this->callback) {
139			call_user_func($this->callback, $this);
140			}
141
142			$response = function () {
143			$handle = fopen('php://output', 'w');
144			$titles = [];
145
146			$this->chunk(function ($collection) use ($handle, &$titles) {
147
148			Column::setOriginalGridModels($collection);
149
150			$original = $current = $collection->toArray();
151
152			$this->grid->getColumns()->map(function (Column $column) use (&$current) {
153			$current = $column->fill($current);
154			$this->grid->columnNames[] = $column->getName();
155			});
156
157			// Write title
158			if (empty($titles)) {
159			fputcsv($handle, $titles = $this->getVisiableTitles());
160			}
161
162			// Write rows
163			foreach ($current as $index => $record) {
164			fputcsv($handle, $this->getVisiableFields($record, $original[$index]));
165			}
166			});
167			fclose($handle);
168			};
169
170			response()->stream($response, 200, $this->getHeaders())->send();
			0 ignored issues – show Bug introduced 2020-04-28 09:46 UTC by Report Bug Copy Issue Report The method `stream` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
171
172			exit;
173			}
174
175			/**
176			* @return array
177			*/
178			protected function getVisiableTitles()
179			{
180			$titles = $this->grid->visibleColumns()
			0 ignored issues – show Bug introduced 2020-04-28 09:46 UTC by Report Bug Copy Issue Report The method `mapWithKeys` does only exist in `Illuminate\Support\Collection`, but not in `Encore\Admin\Grid\Concerns\CanHidesColumns`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
181			->mapWithKeys(function (Column $column) {
182			return [$column->getName() => $column->getLabel()];
183			});
184
185			if ($this->onlyColumns) {
			0 ignored issues – show Bug Best Practice introduced 2020-04-28 09:46 UTC by Report Bug Copy Issue Report The expression `$this->onlyColumns` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
186			$titles = $titles->only($this->onlyColumns);
187			}
188
189			if ($this->exceptColumns) {
			0 ignored issues – show Bug Best Practice introduced 2020-04-28 09:46 UTC by Report Bug Copy Issue Report The expression `$this->exceptColumns` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
190			$titles = $titles->except($this->exceptColumns);
191			}
192
193			$this->visibleColumns = $titles->keys();
194
195			return $titles->values()->toArray();
196			}
197
198			/**
199			* @param array $value
200			* @param array $original
201			* @return array
202			*/
203			public function getVisiableFields(array $value, array $original): array
204			{
205			$fields = [];
206
207			foreach ($this->visibleColumns as $column) {
208			$fields[] = $this->getColumnValue(
209			$column,
210			data_get($value, $column),
211			data_get($original, $column)
212			);
213			}
214
215			return $fields;
216			}
217
218			/**
219			* @param string $column
220			* @param mixed $value
221			* @param mixed $original
222			* @return mixed
223			*/
224			protected function getColumnValue(string $column, $value, $original)
225			{
226			if (!empty($this->columnUseOriginalValue)
227			&& in_array($column, $this->columnUseOriginalValue)) {
228			return $original;
229			}
230
231			if (isset($this->columnCallbacks[$column])) {
232			return $this->columnCallbacks[$column]($value, $original);
233			}
234
235			return $value;
236			}
237			}
238

z-song / laravel-admin

Push — master ( f09455...266dce )

CsvExporter::filename() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like