ViewComponents\Grids\Component\CsvExport

Complexity

Total Complexity

24

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

0%

Importance

Changes	7
Bugs	4	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	setInputOption()	0	5	1
A	attachToCompound()	0	10	2
A	removePagination()	0	7	2
A	getInputOption()	0	4	1
A	setExitFunction()	0	5	1
A	getExitFunction()	0	4	1
A	getCsvDelimiter()	0	4	1
A	setCsvDelimiter()	0	5	1
A	setFileName()	0	5	1
A	getFileName()	0	4	1
B	renderCsv()	0	24	3
A	escapeString()	0	4	1
A	renderHeadingRow()	0	10	2
A	finishApplication()	0	7	2
A	getExportUrl()	0	4	1
A	makeDefaultView()	0	14	1

<?php

namespace ViewComponents\Grids\Component;

use ViewComponents\ViewComponents\Base\ViewComponentInterface;
use ViewComponents\ViewComponents\Common\UriFunctions;
use ViewComponents\ViewComponents\Component\Compound;
use ViewComponents\ViewComponents\Component\DataView;
use ViewComponents\ViewComponents\Component\Html\Tag;
use ViewComponents\ViewComponents\Component\Part;
use ViewComponents\ViewComponents\Data\DataProviderInterface;
use ViewComponents\ViewComponents\Data\Operation\PaginateOperation;
use ViewComponents\ViewComponents\Input\InputOption;
use ViewComponents\Grids\Grid;

class CsvExport extends Part
{

    private $fileName = 'data.csv';
    private $csvDelimiter = ';';
    private $exitFunction;

    /**
     * @var InputOption
     */
    private $inputOption;

    public function __construct(InputOption $inputOption = null, ViewComponentInterface $controlView = null)
    {
        $this->inputOption = $inputOption;
        parent::__construct($controlView ?: $this->makeDefaultView(), 'csv_export', 'control_container');
    }

    /**
     * @param InputOption $inputOption
     * @return CsvExport
     */
    public function setInputOption($inputOption)
    {
        $this->inputOption = $inputOption;
        return $this;
    }

    /**
     * @return InputOption
     */
    public function getInputOption()
    {
        return $this->inputOption;
    }

    /**
     * Sets exit function.
     *
     * You may specify custom exit function to finish application cleanly.
     * 'exit' will be called after rendering CSV if no exit function specified.
     *
     * @param callable|null $exitFunction
     * @return $this
     */
    public function setExitFunction($exitFunction)
    {
        $this->exitFunction = $exitFunction;
        return $this;
    }

    /**
     * @return callable|null
     */
    public function getExitFunction()
    {
        return $this->exitFunction;
    }

    /**
     * @return string
     */
    public function getCsvDelimiter()
    {
        return $this->csvDelimiter;
    }

    /**
     * @param string $csvDelimiter
     * @return $this
     */
    public function setCsvDelimiter($csvDelimiter)
    {
        $this->csvDelimiter = $csvDelimiter;
        return $this;
    }

    /**
     * @param string $name
     * @return $this
     */
    public function setFileName($name)
    {
        $this->fileName = $name;
        return $this;
    }

    /**
     * @return string
     */
    public function getFileName()
    {
        return $this->fileName;
    }

    public function attachToCompound(Compound $root, $prepend = false)
    {
        // prepend component that will render results
        $root->children()->add(new DataView(function () {

The method add() does not seem to exist on object<Nayjest\Collection\Decorator\ReadonlyObjectCollection>.

            if ($this->inputOption->hasValue()) {
                $this->renderCsv();
            }
        }), true);
        parent::attachToCompound($root, $prepend);
    }

    protected function removePagination(DataProviderInterface $provider)
    {
        $pagination = $provider->operations()->findByType(PaginateOperation::class);
        if ($pagination) {
            $provider->operations()->remove($pagination);
        }
    }

    protected function renderCsv()
    {
        ob_clean(); // removes previous output from buffer if grid was rendered inside view
        $file = fopen('php://output', 'w');
        header('Content-Type: text/csv');
        header('Content-Disposition: attachment; filename="' . $this->getFileName() . '"');
        header('Pragma: no-cache');
        set_time_limit(0);
        /** @var Grid $grid */
        $grid = $this->root;
        $provider = $grid->getDataProvider();
        $this->renderHeadingRow($file);
        $this->removePagination($provider);

It seems like $provider defined by $grid->getDataProvider() on line 140 can be null; however, ViewComponents\Grids\Component\CsvExport::removePagination() does not accept null, maybe add an additional type check?

        foreach ($provider as $row) {

The expression $provider of type object<ViewComponents\ViewComponents\Data\DataProviderInterface>|null is not guaranteed to be traversable. How about adding an additional type check?

            $output = [];
            $grid->setCurrentRow($row);
            foreach ($grid->getColumns() as $column) {
                $output[] = $this->escapeString($column->getCurrentValueFormatted());
            }
            fputcsv($file, $output, $this->getCsvDelimiter());
        }
        fclose($file);
        $this->finishApplication();
    }

    protected function escapeString($str)
    {
        return str_replace('"', '\'', strip_tags(html_entity_decode($str)));
    }

    /**
     * @param resource $file
     */
    protected function renderHeadingRow($file)
    {
        $output = [];
        /** @var Grid $grid */
        $grid = $this->root;
        foreach ($grid->getColumns() as $column) {
            $output[] = $this->escapeString($column->getLabel());
        }
        fputcsv($file, $output, $this->getCsvDelimiter());
    }

    protected function finishApplication()
    {
        if (!$this->getExitFunction()) {
            exit;

The method finishApplication() contains an exit expression.

        }
        call_user_func($this->getExitFunction());
    }

    public function getExportUrl()
    {
        return UriFunctions::modifyQuery(null, [$this->inputOption->getKey() => 1]);
    }

    protected function makeDefaultView()
    {
        $href = $this->getExportUrl();
        return new Tag(
            'button',
            [
                // required to avoid emitting 'click' on pressing enter
                'type' => 'button',
                'onclick' => "window.location='$href'; return false;",
                'style' => 'margin:2px;'
            ],
            [new DataView('CSV Export')]
        );
    }
}