UsesCsv::generateCsv() - Code Metrics - Inspection of "v1.3.0" - bristol-su/control - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#12)

by Toby

created 2020-04-08 15:55 UTC

UsesCsv::generateCsv() A

↳ Parent: UsesCsv

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	6
c	1
b	0
f	0
dl	0
loc	13
ccs	7
cts	7
cp	1
rs	10
cc	2
nc	2
nop	2
crap	2

<?php

Coding Style introduced 2020-04-08 16:06 UTC by

Missing file doc comment

namespace BristolSU\ControlDB\Export\Handler;

use BristolSU\ControlDB\Export\FormattedItem;

use Illuminate\Support\Str;

trait UsesCsv

Coding Style introduced 2020-04-08 16:06 UTC by

Missing doc comment for trait UsesCsv

/**

Coding Style introduced 2020-04-08 16:06 UTC by

Missing short description in doc comment

     * @param array|FormattedItem[] $items

Coding Style introduced 2020-04-08 16:06 UTC by

Missing parameter comment

Coding Style introduced 2020-04-08 16:06 UTC by

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return array

Coding Style introduced 2020-04-08 16:06 UTC by

Tag @return cannot be grouped with parameter tags in a doc comment

*/

    public function getHeaders($items)

        $headers = [];

        foreach($items as $item) {

Coding Style introduced 2020-04-08 16:06 UTC by

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            foreach($item->getColumnNames() as $column) {

Coding Style introduced 2020-04-08 16:06 UTC by

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                if(!in_array($column, $headers)) {

Coding Style introduced 2020-04-08 16:06 UTC by

Expected "if (...) {\n"; found "if(...) {\n"

                    $headers[] = $column;

        return $headers;

/**

Coding Style introduced 2020-04-08 16:06 UTC by

Missing short description in doc comment

     * @param array|FormattedItem[] $items

Coding Style introduced 2020-04-08 16:06 UTC by

Missing parameter comment

Coding Style introduced 2020-04-08 16:06 UTC by

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param null $headers

Documentation Bug introduced 2020-04-08 16:06 UTC by

Are you sure the doc-type for parameter $headers is correct as it would always require null to be passed?

Coding Style introduced 2020-04-08 16:06 UTC by

Missing parameter comment

Coding Style introduced 2020-04-08 16:06 UTC by

Expected 18 spaces after parameter type; 1 found

Coding Style introduced 2020-04-08 16:06 UTC by

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param $defaultIfNull

Coding Style introduced 2020-04-08 16:06 UTC by

Missing parameter comment

Coding Style introduced 2020-04-08 16:06 UTC by

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return array

Coding Style introduced 2020-04-08 16:06 UTC by

Tag @return cannot be grouped with parameter tags in a doc comment

*/

    public function getRows($items, $headers = null, $defaultIfNull = null)

        $headers = $headers ?? $this->getHeaders($items);

        $rows = [];

        foreach($items as $item) {

Coding Style introduced 2020-04-08 16:06 UTC by

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $row = [];

            foreach($headers as $header) {

Coding Style introduced 2020-04-08 16:06 UTC by

Expected "foreach (...) {\n"; found "foreach(...) {\n"

                $row[] = $item->getItem($header, $defaultIfNull);

            $rows[] = $row;

        return $rows;

    public function generateCsv($items, $defaultIfNull = null)

Coding Style introduced 2020-04-08 16:06 UTC by

Missing doc comment for function generateCsv()

        $csv = tmpfile();

        $headers = $this->getHeaders($items);

        fputcsv($csv, $this->getHeaders($items));

Bug introduced 2020-04-08 16:06 UTC by

It seems like $csv can also be of type false; however, parameter $handle of fputcsv() does only seem to accept resource, maybe add an additional type check? ( Ignorable by Annotation )

        foreach($this->getRows($items, $headers, $defaultIfNull) as $row) {

Coding Style introduced 2020-04-08 16:06 UTC by

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            fputcsv($csv, $row);

        return $csv;

bristol-su / control

GitHub Access Token became invalid

Pull Request — master (#12)

UsesCsv::generateCsv() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like