AbstractImporter::newCollection() - Code Metrics - Inspection of "Merge pull request #11 from ARCANEDEV/update-1" - ARCANEDEV/LaravelExcel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 29537e...cc9e82 )

by ARCANEDEV

created 2018-09-06 11:04 UTC

AbstractImporter::newCollection() A

↳ Parent: AbstractImporter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	0
crap	1

<?php namespace Arcanedev\LaravelExcel\Importers;

use Arcanedev\LaravelExcel\Contracts\Importer as ImporterContract;
use Arcanedev\LaravelExcel\Contracts\Parser as ParserContract;
use Arcanedev\LaravelExcel\Traits\WithOptions;
use Box\Spout\Reader\ReaderFactory;
use Illuminate\Support\Collection;

/**
 * Class     AbstractExporter
 *
 * @package  Arcanedev\LaravelExcel\Importer
 * @author   ARCANEDEV <[email protected]>
 *
 * @todo: Refactor the parse methods
 */
abstract class AbstractImporter implements ImporterContract
{
    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use WithOptions;

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var  string */
    protected $type;

    /** @var  string */
    protected $path = '';

    /** @var  \Arcanedev\LaravelExcel\Contracts\Parser */
    protected $parser;

    /** @var \Box\Spout\Reader\ReaderInterface */
    protected $reader;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * AbstractImporter constructor.
     *
     * @param  array  $options
     */
    public function __construct(array $options = [])
    {
        $this->setParser(new DefaultParser);
        $this->setOptions($options);
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Set the path.
     *
     * @param  string  $path
     *
     * @return self
     */
    public function setPath($path)
    {
        $this->path = $path;

        return $this;
    }

    /**
     * Set the parser.
     *
     * @param  \Arcanedev\LaravelExcel\Contracts\Parser  $parser
     *
     * @return self
     */
    public function setParser(ParserContract $parser)
    {
        $this->parser = $parser;

        return $this;
    }

    /**
     * Get the file type.
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Load the file.
     *
     * @param  string  $path
     *
     * @return self
     */
    public function load($path)
    {
        return $this->setPath($path);
    }

    /**
     * Get the parsed data for a single sheet.
     *
     * @param  int|string  $sheet
     *
     * @return \Illuminate\Support\Collection
     */
    public function get($sheet = 1)
    {
        $this->create();
        $this->reader->open($this->path);
        $collection = $this->parseRows($sheet);
        $this->reader->close();

        return $collection;
    }

    /**
     * Get the parsed data for all sheets.
     *
     * @return \Illuminate\Support\Collection
     */
    public function all()
    {
        return $this->get('*');
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create the reader instance.
     */
    protected function create()
    {
        $this->reader = ReaderFactory::create($this->type);
        $this->loadOptions();
    }

    /**
     * Load the reader options.
     */
    abstract protected function loadOptions();

    /**
     * Parse the rows of selected sheet.
     *
     * @param  int|string  $sheetIndex
     *
     * @return \Illuminate\Support\Collection
     */
    protected function parseRows($sheetIndex)
    {
        $sheets = $this->newCollection();

        foreach ($this->reader->getSheetIterator() as $index => $sheet) {
            if ($sheetIndex === '*') {
                $rows = $this->newCollection();

                foreach ($sheet->getRowIterator() as $row) {
                    $rows->push($this->parser->transform($row));
                }

                $sheets->put($index, $rows);
            }
            elseif ($sheetIndex === $index) {
                foreach ($sheet->getRowIterator() as $row) {
                    $sheets->push($this->parser->transform($row));
                }
                break;
            }
        }

        return $sheets;
    }

    /**
     * Create a new collection object.
     *
     * @return \Illuminate\Support\Collection
     */
    protected function newCollection()
    {
        return new Collection;
    }
}


1		<?php namespace Arcanedev\LaravelExcel\Importers;
2
3		use Arcanedev\LaravelExcel\Contracts\Importer as ImporterContract;
4		use Arcanedev\LaravelExcel\Contracts\Parser as ParserContract;
5		use Arcanedev\LaravelExcel\Traits\WithOptions;
6		use Box\Spout\Reader\ReaderFactory;
7		use Illuminate\Support\Collection;
8
9		/**
10		* Class AbstractExporter
11		*
12		* @package Arcanedev\LaravelExcel\Importer
13		* @author ARCANEDEV <[email protected]>
14		*
15		* @todo: Refactor the parse methods
16		*/
17		abstract class AbstractImporter implements ImporterContract
18		{
19		/* -----------------------------------------------------------------
20		\| Traits
21		\| -----------------------------------------------------------------
22		*/
23
24		use WithOptions;
25
26		/* -----------------------------------------------------------------
27		\| Properties
28		\| -----------------------------------------------------------------
29		*/
30
31		/** @var string */
32		protected $type;
33
34		/** @var string */
35		protected $path = '';
36
37		/** @var \Arcanedev\LaravelExcel\Contracts\Parser */
38		protected $parser;
39
40		/** @var \Box\Spout\Reader\ReaderInterface */
41		protected $reader;
42
43		/* -----------------------------------------------------------------
44		\| Constructor
45		\| -----------------------------------------------------------------
46		*/
47
48		/**
49		* AbstractImporter constructor.
50		*
51		* @param array $options
52		*/
53	57	public function __construct(array $options = [])
54		{
55	57	$this->setParser(new DefaultParser);
56	57	$this->setOptions($options);
57	57	}
58
59		/* -----------------------------------------------------------------
60		\| Getters & Setters
61		\| -----------------------------------------------------------------
62		*/
63
64		/**
65		* Set the path.
66		*
67		* @param string $path
68		*
69		* @return self
70		*/
71	18	public function setPath($path)
72		{
73	18	$this->path = $path;
74
75	18	return $this;
76		}
77
78		/**
79		* Set the parser.
80		*
81		* @param \Arcanedev\LaravelExcel\Contracts\Parser $parser
82		*
83		* @return self
84		*/
85	57	public function setParser(ParserContract $parser)
86		{
87	57	$this->parser = $parser;
88
89	57	return $this;
90		}
91
92		/**
93		* Get the file type.
94		*
95		* @return string
96		*/
97	21	public function getType()
98		{
99	21	return $this->type;
100		}
101
102		/* -----------------------------------------------------------------
103		\| Main Methods
104		\| -----------------------------------------------------------------
105		*/
106
107		/**
108		* Load the file.
109		*
110		* @param string $path
111		*
112		* @return self
113		*/
114	18	public function load($path)
115		{
116	18	return $this->setPath($path);
117		}
118
119		/**
120		* Get the parsed data for a single sheet.
121		*
122		* @param int\|string $sheet
123		*
124		* @return \Illuminate\Support\Collection
125		*/
126	18	public function get($sheet = 1)
127		{
128	18	$this->create();
129	18	$this->reader->open($this->path);
130	18	$collection = $this->parseRows($sheet);
131	18	$this->reader->close();
132
133	18	return $collection;
134		}
135
136		/**
137		* Get the parsed data for all sheets.
138		*
139		* @return \Illuminate\Support\Collection
140		*/
141	9	public function all()
142		{
143	9	return $this->get('*');
144		}
145
146		/* -----------------------------------------------------------------
147		\| Other Methods
148		\| -----------------------------------------------------------------
149		*/
150
151		/**
152		* Create the reader instance.
153		*/
154	18	protected function create()
155		{
156	18	$this->reader = ReaderFactory::create($this->type);
157	18	$this->loadOptions();
158	18	}
159
160		/**
161		* Load the reader options.
162		*/
163		abstract protected function loadOptions();
164
165		/**
166		* Parse the rows of selected sheet.
167		*
168		* @param int\|string $sheetIndex
169		*
170		* @return \Illuminate\Support\Collection
171		*/
172	18	protected function parseRows($sheetIndex)
173		{
174	18	$sheets = $this->newCollection();
175
176	18	foreach ($this->reader->getSheetIterator() as $index => $sheet) {
177	18	if ($sheetIndex === '*') {
178	9	$rows = $this->newCollection();
179
180	9	foreach ($sheet->getRowIterator() as $row) {
181	9	$rows->push($this->parser->transform($row));
182		}
183
184	9	$sheets->put($index, $rows);
185		}
186	9	elseif ($sheetIndex === $index) {
187	9	foreach ($sheet->getRowIterator() as $row) {
188	9	$sheets->push($this->parser->transform($row));
189		}
190	15	break;
191		}
192		}
193
194	18	return $sheets;
195		}
196
197		/**
198		* Create a new collection object.
199		*
200		* @return \Illuminate\Support\Collection
201		*/
202	18	protected function newCollection()
203		{
204	18	return new Collection;
205		}
206		}
207

ARCANEDEV / LaravelExcel

Push — master ( 29537e...cc9e82 )

AbstractImporter::newCollection() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like