CsvImportAdapter::__construct() - Code Metrics - Inspection of "Add CSV import + export adapter + Add plugin + sub..." - techdivision/import - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#81)

by Tim

created 2017-06-28 14:40 UTC

CsvImportAdapter::__construct() A

↳ Parent: CsvImportAdapter

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	5
ccs	0
cts	5
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2
crap	2

<?php

/**
 * TechDivision\Import\Adapter\CsvImportAdapter
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Adapter;

use Goodby\CSV\Import\Protocol\LexerInterface;
use Goodby\CSV\Import\Protocol\InterpreterInterface;

/**
 * CSV import adapter implementation.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */
class CsvImportAdapter implements ImportAdapterInterface
{

    /**
     * The lexer instance.
     *
     * @var \Goodby\CSV\Import\Protocol\LexerInterface
     */
    protected $lexer;

    /**
     * The interpreter instance.
     *
     * @var \Goodby\CSV\Import\Protocol\InterpreterInterface
     */
    protected $interpreter;

    /**
     * Initialize the adapter with the configuration.
     *
     * @param \Goodby\CSV\Import\Protocol\LexerInterface       $lexer       The lexer instance
     * @param \Goodby\CSV\Import\Protocol\InterpreterInterface $interpreter The interpreter instance
     */
    public function __construct(LexerInterface $lexer, InterpreterInterface $interpreter)
    {
        $this->lexer = $lexer;
        $this->interpreter = $interpreter;
    }

    /**
     * Imports the content of the CSV file with the passed filename.
     *
     * @param callable $callback The callback that processes the row
     * @param string   $filename The filename to process
     *
     * @return void
     */
    public function import(callable $callback, $filename)
    {

        // reset and initialize the interpreter
        $this->interpreter->reset();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $this->interpreter->addObserver($callback);

        // parse the CSV file to be imported
        $this->lexer->parse($filename, $this->interpreter);
    }
}


1			<?php
2
3			/**
4			* TechDivision\Import\Adapter\CsvImportAdapter
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2016 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/techdivision/import
18			* @link http://www.techdivision.com
19			*/
20
21			namespace TechDivision\Import\Adapter;
22
23			use Goodby\CSV\Import\Protocol\LexerInterface;
24			use Goodby\CSV\Import\Protocol\InterpreterInterface;
25
26			/**
27			* CSV import adapter implementation.
28			*
29			* @author Tim Wagner <[email protected]>
30			* @copyright 2016 TechDivision GmbH <[email protected]>
31			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
32			* @link https://github.com/techdivision/import
33			* @link http://www.techdivision.com
34			*/
35			class CsvImportAdapter implements ImportAdapterInterface
36			{
37
38			/**
39			* The lexer instance.
40			*
41			* @var \Goodby\CSV\Import\Protocol\LexerInterface
42			*/
43			protected $lexer;
44
45			/**
46			* The interpreter instance.
47			*
48			* @var \Goodby\CSV\Import\Protocol\InterpreterInterface
49			*/
50			protected $interpreter;
51
52			/**
53			* Initialize the adapter with the configuration.
54			*
55			* @param \Goodby\CSV\Import\Protocol\LexerInterface $lexer The lexer instance
56			* @param \Goodby\CSV\Import\Protocol\InterpreterInterface $interpreter The interpreter instance
57			*/
58			public function __construct(LexerInterface $lexer, InterpreterInterface $interpreter)
59			{
60			$this->lexer = $lexer;
61			$this->interpreter = $interpreter;
62			}
63
64			/**
65			* Imports the content of the CSV file with the passed filename.
66			*
67			* @param callable $callback The callback that processes the row
68			* @param string $filename The filename to process
69			*
70			* @return void
71			*/
72			public function import(callable $callback, $filename)
73			{
74
75			// reset and initialize the interpreter
76			$this->interpreter->reset();
			0 ignored issues – show Bug introduced 2017-06-28 14:44 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Goodby\CSV\Import\Protocol\InterpreterInterface` as the method `reset()` does only exist in the following implementations of said interface: `TechDivision\Import\Adapter\Goodby\Interpreter`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
77			$this->interpreter->addObserver($callback);
78
79			// parse the CSV file to be imported
80			$this->lexer->parse($filename, $this->interpreter);
81			}
82			}
83

techdivision / import

Pull Request — master (#81)

CsvImportAdapter::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like