miquido/csv-file-reader

View on GitHub

Showing 3 of 3 total issues

The method __construct has a boolean flag argument $firstLineHeader, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function __construct(string $filePath, bool $firstLineHeader = true, CsvControl $csvControl = null)
Severity: Minor
Found in src/CsvFile.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

Missing class import via use statement (line '37', column '23').
Open

            throw new \InvalidArgumentException('CsvFile already has invalid line handler');
Severity: Minor
Found in src/CsvFileReader.php by phpmd

MissingImport

Since: 2.7.0

Importing all external classes in a file through use statements makes them clearly visible.

Example

function make() {
    return new \stdClass();
}

Source http://phpmd.org/rules/cleancode.html#MissingImport

Define a constant instead of duplicating this literal "Invalid header line." 3 times.
Open

        Assert::notEmpty($header, 'Invalid header line.');

Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

Noncompliant Code Example

With the default threshold of 3:

function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

Compliant Solution

ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

Exceptions

To prevent generating some false-positives, literals having less than 5 characters are excluded.

Severity
Category
Status
Source
Language