LeKoala\ExcelImportExport\ExcelGridFieldExportButton

Complexity

Total Complexity

66

Size/Duplication

Total Lines	498
Duplicated Lines	0 %

Importance

Changes	8
Bugs	3	Features	0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	setListFilters()	0	4	1
A	setHasHeader()	0	4	1
F	generateExportFileData()	0	154	35
A	getActions()	0	3	1
A	getActionName()	0	4	1
A	getAfterExportCallback()	0	3	1
A	getListFilters()	0	3	1
A	setExportType()	0	4	1
A	setCheckCanView()	0	4	1
A	setButtonTitle()	0	4	1
A	setExportName()	0	4	1
A	getIsLimited()	0	3	1
A	handleExport()	0	32	5
A	handleAction()	0	8	2
A	getExportColumns()	0	3	1
A	getExportType()	0	3	1
A	getHasHeader()	0	3	1
A	getURLHandlers()	0	3	1
A	setAfterExportCallback()	0	4	1
A	getCheckCanView()	0	3	1
A	getHTMLFragments()	0	21	2
A	getExportName()	0	3	1
A	setIsLimited()	0	4	1
A	setExportColumns()	0	4	1
A	getButtonTitle()	0	3	1
A	__construct()	0	4	1

<?php

namespace LeKoala\ExcelImportExport;

use PhpOffice\PhpSpreadsheet\IOFactory;
use SilverStripe\Assets\FileNameFilter;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use SilverStripe\Forms\GridField\GridField;
use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use SilverStripe\Forms\GridField\GridFieldPaginator;
use SilverStripe\Forms\GridField\GridField_FormAction;
use SilverStripe\Forms\GridField\GridField_URLHandler;
use SilverStripe\Forms\GridField\GridFieldFilterHeader;
use SilverStripe\Forms\GridField\GridField_HTMLProvider;
use SilverStripe\Forms\GridField\GridFieldSortableHeader;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
use Exception;
use SilverStripe\ORM\DataList;

/**
 * Adds an "Export list" button to the bottom of a {@link GridField}.
 */
class ExcelGridFieldExportButton implements
    GridField_HTMLProvider,
    GridField_ActionProvider,
    GridField_URLHandler
{
    /**
     * @var array Map of a property name on the exported objects, with values being the column title in the file.
     * Note that titles are only used when {@link $hasHeader} is set to TRUE.
     */
    protected $exportColumns;

    /**
     * Fragment to write the button to
     */
    protected $targetFragment;

    /**
     * @var boolean
     */
    protected $hasHeader = true;

    /**
     * @var string
     */
    protected $exportType = 'xlsx';

    /**
     * @var string
     */
    protected $exportName = null;

    /**
     *
     * @var string
     */
    protected $buttonTitle = null;

    /**
     *
     * @var bool
     */
    protected $checkCanView = true;

    /**
     * @var bool
     */
    protected $isLimited = true;

    /**
     *
     * @var array
     */
    protected $listFilters = array();

    /**
     *
     * @var callable
     */
    protected $afterExportCallback;

    /**
     * @param string $targetFragment The HTML fragment to write the button into
     * @param array $exportColumns The columns to include in the export
     */
    public function __construct($targetFragment = "after", $exportColumns = null)
    {
        $this->targetFragment = $targetFragment;
        $this->exportColumns = $exportColumns;
    }

    /**
     * @param GridField $gridField
     * @return string
     */
    public function getActionName($gridField)
    {
        $name = strtolower($gridField->getName());
        return 'excelexport_' . $name;
    }

    /**
     * Place the export button in a <p> tag below the field
     */
    public function getHTMLFragments($gridField)
    {
        $title = $this->buttonTitle ? $this->buttonTitle : _t(
            'ExcelImportExport.XLSEXPORT',
            'Export to Excel'
        );

        $name = $this->getActionName($gridField);

        $button = new GridField_FormAction(
            $gridField,
            $name,
            $title,
            $name,
            null
        );
        $button->addExtraClass('btn btn-secondary no-ajax font-icon-down-circled action_export');
        $button->setForm($gridField->getForm());

        return array(
            $this->targetFragment => $button->Field()
        );
    }

    /**
     * export is an action button
     */
    public function getActions($gridField)
    {
        return array($this->getActionName($gridField));
    }

    public function handleAction(
        GridField $gridField,
        $actionName,
        $arguments,
        $data
    ) {
        if (in_array($actionName, $this->getActions($gridField))) {
            return $this->handleExport($gridField);

Are you sure the usage of $this->handleExport($gridField) targeting LeKoala\ExcelImportExport\ExcelGridFieldExportButton::handleExport() seems to always return null.

        }
    }

    /**
     * it is also a URL
     */
    public function getURLHandlers($gridField)
    {
        return array($this->getActionName($gridField) => 'handleExport');
    }

    /**
     * Handle the export, for both the action button and the URL
     */
    public function handleExport($gridField, $request = null)
    {
        $now = Date("Ymd_Hi");

        if ($excel = $this->generateExportFileData($gridField)) {
            $ext = $this->exportType;
            $name = $this->exportName;
            $fileName = "$name-$now.$ext";

            switch ($ext) {
                case 'xls':
                    $writer = IOFactory::createWriter($excel, 'Xls');
                    break;
                case 'xlsx':
                    $writer = IOFactory::createWriter($excel, 'Xlsx');
                    break;
                default:
                    throw new Exception("$ext is not supported");
            }
            if ($this->afterExportCallback) {
                $func = $this->afterExportCallback;
                $func();
            }

            header("Cache-Control: no-store, no-cache, must-revalidate, max-age=0");
            header("Cache-Control: post-check=0, pre-check=0", false);
            header("Pragma: no-cache");
            header('Content-type: application/vnd.ms-excel');
            header('Content-Disposition: attachment; filename="' . $fileName . '"');

            $writer->save('php://output');
            exit();

Using exit here is not recommended.

        }
    }

    /**
     * Generate export fields for Excel.
     *
     * @param GridField $gridField
     * @return Spreadsheet
     */
    public function generateExportFileData($gridField)
    {
        $class = $gridField->getModelClass();
        $columns = ($this->exportColumns) ? $this->exportColumns : ExcelImportExport::exportFieldsForClass($class);

        $singl = singleton($class);

        $plural = $class ? $singl->i18n_plural_name() : '';

        $filter = new FileNameFilter;
        if ($this->exportName) {
            $this->exportName = $filter->filter($this->exportName);
        } else {
            $this->exportName = $filter->filter('export-' . $plural);
        }

        $excel = new Spreadsheet();
        $excelProperties = $excel->getProperties();
        $excelProperties->setTitle($this->exportName);

        $sheet = $excel->getActiveSheet();
        if ($plural) {
            $sheet->setTitle($plural);
        }

        $row = 1;
        $col = 1;

        if ($this->hasHeader) {
            $headers = array();

            // determine the headers. If a field is callable (e.g. anonymous function) then use the
            // source name as the header instead
            foreach ($columns as $columnSource => $columnHeader) {
                $headers[] = (!is_string($columnHeader) && is_callable($columnHeader))
                    ? $columnSource : $columnHeader;
            }

            foreach ($headers as $header) {
                $sheet->setCellValue([$col, $row], $header);
                $col++;
            }

            $endcol = Coordinate::stringFromColumnIndex($col - 1);
            $sheet->setAutoFilter("A1:{$endcol}1");
            $sheet->getStyle("A1:{$endcol}1")->getFont()->setBold(true);

            $col = 1;
            $row++;
        }

        // Autosize
        $cellIterator = $sheet->getRowIterator()->current()->getCellIterator();
        try {
            $cellIterator->setIterateOnlyExistingCells(true);
        } catch (Exception $ex) {
            // Ignore exceptions
        }
        foreach ($cellIterator as $cell) {
            $sheet->getColumnDimension($cell->getColumn())->setAutoSize(true);

The method getColumn() does not exist on null.

        }

        //Remove GridFieldPaginator as we're going to export the entire list.
        $gridField->getConfig()->removeComponentsByType(GridFieldPaginator::class);

        $items = $gridField->getManipulatedList();

        // @todo should GridFieldComponents change behaviour based on whether others are available in the config?
        foreach ($gridField->getConfig()->getComponents() as $component) {
            if ($component instanceof GridFieldFilterHeader || $component instanceof GridFieldSortableHeader) {
                $items = $component->getManipulatedData($gridField, $items);
            }
        }

        $list = $items;
        $limit = ExcelImportExport::$limit_exports;
        if ($items instanceof DataList && $this->isLimited && $limit > 0) {
            $list = $items->limit($limit);
            if (!empty($this->listFilters)) {
                $list = $list->filter($this->listFilters);
            }
        }

        if (!$list) {
            return $excel;
        }

        $exportFormat = ExcelImportExport::config()->export_format;

        foreach ($list as $item) {
            if ($this->checkCanView) {
                $canView = true;
                if ($item->hasMethod('canView') && !$item->canView()) {
                    $canView = false;
                }
                if (!$canView) {
                    continue;
                }
            }
            foreach ($columns as $columnSource => $columnHeader) {
                if (!is_string($columnHeader) && is_callable($columnHeader)) {
                    if ($item->hasMethod($columnSource)) {
                        $relObj = $item->{$columnSource}();
                    } else {
                        $relObj = $item->relObject($columnSource);
                    }

                    $value = $columnHeader($relObj);
                } else {
                    if (is_string($columnSource)) {
                        // It can be a method
                        if (strpos($columnSource, '(') !== false) {
                            $matches = [];
                            preg_match('/([a-zA-Z]*)\((.*)\)/', $columnSource, $matches);
                            $func = $matches[1];
                            $params = explode(",", $matches[2]);
                            // Support only one param for now
                            $value = $item->$func($params[0]);
                        } else {
                            if (array_key_exists($columnSource, $exportFormat)) {
                                $format = $exportFormat[$columnSource];
                                $value = $item->dbObject($columnSource)->$format();
                            } else {
                                $value = $gridField->getDataFieldValue($item, $columnSource);
                            }
                        }
                    } else {
                        // We can also use a simple dot notation
                        $parts = explode(".", $columnHeader);
                        if (count($parts) == 1) {
                            $value = $item->$columnHeader;
                        } else {
                            $value = $item->relObject($parts[0]);
                            if ($value) {
                                $relObjField = $parts[1];
                                $value = $value->$relObjField;
                            }
                        }
                    }
                }

                $sheet->setCellValue([$col, $row], $value);
                $col++;
            }

            if ($item->hasMethod('destroy')) {
                $item->destroy();
            }

            $col = 1;
            $row++;
        }

        return $excel;
    }

    /**
     * @return array
     */
    public function getExportColumns()
    {
        return $this->exportColumns;
    }

    /**
     * @param array
     */
    public function setExportColumns($cols)
    {
        $this->exportColumns = $cols;
        return $this;
    }

    /**
     * @return boolean
     */
    public function getHasHeader()
    {
        return $this->hasHeader;
    }

    /**
     * @param boolean
     */
    public function setHasHeader($bool)
    {
        $this->hasHeader = $bool;
        return $this;
    }

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

    /**
     * @param string xlsx (default) or xls

The type LeKoala\ExcelImportExport\xlsx was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function setExportType($exportType)
    {
        $this->exportType = $exportType;
        return $this;
    }

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

    /**
     * @param string $exportName
     * @return ExcelGridFieldExportButton
     */
    public function setExportName($exportName)
    {
        $this->exportName = $exportName;
        return $this;
    }

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

    /**
     * @param string $buttonTitle
     * @return ExcelGridFieldExportButton
     */
    public function setButtonTitle($buttonTitle)
    {
        $this->buttonTitle = $buttonTitle;
        return $this;
    }

    /**
     *
     * @return bool
     */
    public function getCheckCanView()
    {
        return $this->checkCanView;
    }

    /**
     *
     * @param bool $checkCanView
     * @return ExcelGridFieldExportButton
     */
    public function setCheckCanView($checkCanView)
    {
        $this->checkCanView = $checkCanView;
        return $this;
    }

    /**
     *
     * @return array
     */
    public function getListFilters()
    {
        return $this->listFilters;
    }

    /**
     *
     * @param array $listFilters
     * @return ExcelGridFieldExportButton
     */
    public function setListFilters($listFilters)
    {
        $this->listFilters = $listFilters;
        return $this;
    }

    /**
     *
     * @return callable
     */
    public function getAfterExportCallback()
    {
        return $this->afterExportCallback;
    }

    /**
     *
     * @param callable $afterExportCallback
     * @return ExcelGridFieldExportButton
     */
    public function setAfterExportCallback(callable $afterExportCallback)
    {
        $this->afterExportCallback = $afterExportCallback;
        return $this;
    }

    /**
     * Get the value of isLimited
     */
    public function getIsLimited(): bool
    {
        return $this->isLimited;
    }

    /**
     * Set the value of isLimited
     *
     * @param bool $isLimited
     */
    public function setIsLimited(bool $isLimited)
    {
        $this->isLimited = $isLimited;
        return $this;
    }
}