Tinyissue\Export\Project\Issue\XlsHandler

Complexity

Total Complexity

9

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes	5
Bugs	2	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	sheetRow()	0	20	4
A	setProject()	0	6	1
B	handle()	0	40	2
A	globalStyle()	0	6	1
A	sheetTitle()	0	7	1

<?php

/*
 * This file is part of the Tinyissue package.
 *
 * (c) Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tinyissue\Export\Project\Issue;

use Maatwebsite\Excel\Classes\LaravelExcelWorksheet;
use Maatwebsite\Excel\Writers\CellWriter;
use Tinyissue\Model\Project;
use Tinyissue\Services\Exporter;

/**
 * XlsHandler is an export class for exporting a project issues into a Xls or Xlsx file.
 *
 * @author Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
 */
class XlsHandler
{
    /**
     * Instance of the project.
     *
     * @var Project
     */
    protected $project;

    /**
     * Collection of project issues.
     *
     * @var Project\Issue[]
     */
    protected $issues;

    /**
     * Columns to export from the issues table.
     *
     * @var array
     */
    protected $columns = [
        'id'         => '',
        'title'      => '',
        'time_quote' => '',
        'created_at' => '',
        'updated_at' => '',
        'closed_at'  => '',
        'status'     => '',
    ];

    /**
     * Columns in the output file.
     *
     * @var array
     */
    protected $header = [
        'tinyissue.id',
        'tinyissue.title',
        'tinyissue.time_quote',
        'tinyissue.label_created',
        'tinyissue.updated',
        'tinyissue.label_closed',
        'tinyissue.status',
    ];

    /**
     * Set an instance of a project model.
     *
     * @param Project $project
     *
     * @return $this
     */
    public function setProject(Project $project)
    {
        $this->project = $project;

        return $this;
    }

    /**
     * @param Exporter $exporter
     *
     * @return void
     */
    public function handle(Exporter $exporter)
    {
        $params = $exporter->getParams();

        $this->setProject($exporter->getParams('route.project'));

$exporter->getParams('route.project') is of type string|object<Illuminate\Database\Eloquent\Model>|null, but the function expects a object<Tinyissue\Model\Project>.

        $query = $this->project->issues()->select(array_keys($this->columns));

It seems like select() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        // Filter issues
        $this->project->filterTitleOrBody($query, $params['keyword']);
        $this->project->filterAssignTo($query, $params['keyword']);
        $this->project->filterTitleOrBody($query, $params['keyword']);

        // Fetch issues
        $this->issues = $query->get();

        // Create CSV file
        $exporter->sheet($this->project->name, function (LaravelExcelWorksheet $sheet) {

            // Global sheet styles
            $this->globalStyle($sheet);

            // Title
            $sheet->mergeCells('A1:G1');
            $sheet->setHeight(1, 50);

50 is of type integer, but the function expects a boolean.

            $sheet->cell('A1', function (CellWriter $cell) {
                $this->sheetTitle($cell);
            });

            // Header
            $sheet->row(2, array_map('trans', $this->header));

            // Rows
            $index = 3;
            foreach ($this->issues as $issue) {
                $this->sheetRow($sheet, $index, $issue);
                ++$index;
            }
        });
    }

    /**
     * Setup sheet global styles.
     *
     * @param LaravelExcelWorksheet $sheet
     *
     * @return void
     */
    protected function globalStyle(LaravelExcelWorksheet $sheet)
    {
        // Font size & family
        $sheet->setFontSize(15);
        $sheet->setFontFamily('Calibri');
    }

    /**
     * Sheet title in the first row.
     *
     * @param CellWriter $cell
     *
     * @return void
     */
    public function sheetTitle(CellWriter $cell)
    {
        $cell->setFontWeight('bold');
        $cell->setBorder('none', 'none', 'none', 'thin');
        $title = trans('tinyissue.export_xls_title', ['name' => $this->project->name, 'count' => count($this->issues)]);
        $cell->setValue($title);
    }

    /**
     * Sheet data row.
     *
     * @param LaravelExcelWorksheet $sheet
     * @param int                   $index
     * @param Project\Issue         $issue
     *
     * @return void
     */
    protected function sheetRow(LaravelExcelWorksheet $sheet, $index, Project\Issue $issue)
    {
        // Setup row data
        array_walk($this->columns, function (&$column, $key, Project\Issue $issue) {
            $column = (string) $issue->$key;
            if ($key === 'status') {
                $column = (int) $issue->status === Project\Issue::STATUS_OPEN ? 'open' : 'closed';
                $column = trans('tinyissue.' . $column);
            }
        }, $issue);

        // Write row
        $sheet->row($index, $this->columns);

        // Format last cell
        $sheet->cell('G' . $index, function (CellWriter $cell) use ($issue) {
            $color = (int) $issue->status === Project\Issue::STATUS_CLOSED ? '#FF0000' : '#00FF00';
            $cell->setBackground($color);
        });
    }
}