BristolSU\ControlDB\Export\Handler\UsesCsv

Complexity

Total Complexity

9

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	generateCsv()	0	13	2
A	getRows()	0	14	3
A	getHeaders()	0	11	4

<?php

Missing file doc comment

namespace BristolSU\ControlDB\Export\Handler;

use BristolSU\ControlDB\Export\FormattedItem;
use Illuminate\Support\Str;

trait UsesCsv

Missing doc comment for trait UsesCsv

{

    /**

Missing short description in doc comment

     * @param array|FormattedItem[] $items

Missing parameter comment

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

     * @return array

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

     */
    public function getHeaders($items)
    {
        $headers = [];
        foreach($items as $item) {

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

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

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

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

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

                    $headers[] = $column;
                }
            }
        }
        return $headers;
    }

    /**

Missing short description in doc comment

     * @param array|FormattedItem[] $items

Missing parameter comment

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

     * @param null $headers

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

Missing parameter comment

Expected 18 spaces after parameter type; 1 found

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

     * @param $defaultIfNull

Missing parameter comment

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

     * @return array

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) {

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

            $row = [];
            foreach($headers as $header) {

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

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

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

Missing doc comment for function generateCsv()

    {
        $csv = tmpfile();

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

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?

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

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

            fputcsv($csv, $row);
        }
        
        return $csv;
    }
    
}