ModelAdminExcelExtension::updateImportForm() - Code Metrics - Inspection of "add custom import handlers support" - lekoala/silverstripe-excel-import-export - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5e779f...172bf8 )

by Thomas

created 2022-10-21 08:30 UTC

ModelAdminExcelExtension::updateImportForm() B

↳ Parent: ModelAdminExcelExtension

Complexity

Conditions	11
Paths	64

Size

Total Lines	77
Code Lines	48

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	2

Metric	Value
eloc	48
c	3
b	0
f	2
dl	0
loc	77
rs	7.3166
cc	11
nc	64
nop	1

How to fix Long Method Complexity

<?php

namespace LeKoala\ExcelImportExport\Extensions;

use SilverStripe\Forms\Form;
use SilverStripe\Core\Extension;
use SilverStripe\Admin\ModelAdmin;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\OptionsetField;
use LeKoala\ExcelImportExport\ExcelBulkLoader;
use LeKoala\ExcelImportExport\ExcelImportExport;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\Forms\GridField\GridFieldExportButton;
use SilverStripe\Forms\GridField\GridFieldImportButton;
use LeKoala\ExcelImportExport\ExcelGridFieldExportButton;
use LeKoala\ExcelImportExport\ExcelGridFieldImportButton;

/**
 * Extends {@link ModelAdmin}. to bind new forms and features
 *
 * @author Koala
 */
class ModelAdminExcelExtension extends Extension
{
    private static $allowed_actions = array(

        'downloadsample'
    );

    public function onAfterInit()
    {
        $this->updateModelImporters();
    }

    /**
     * Replace default model import with a predefined value
     *
     * @return void
     */
    protected function updateModelImporters()
    {
        /* @var $owner ModelAdmin */
        $owner = $this->owner;
        $config = $this->owner->config();

        // Overwrite model imports
        $importerClasses = $config->get('model_importers');

        if (is_null($importerClasses)) {
            $models = $owner->getManagedModels();
            foreach (array_keys($models) as $modelName) {
                $importerClasses[$modelName] = ExcelBulkLoader::class;
            }

            $config->set('model_importers', $importerClasses);
        }
    }

    public function downloadsample()
    {
        ExcelImportExport::sampleFileForClass($this->owner->modelClass);
    }

    public function updateGridFieldConfig(GridFieldConfig $config)
    {
        /** @var ModelAdmin $owner */
        $owner = $this->owner;
        $class = $owner->modelClass;
        $classConfig = $owner->config();

        // Add/remove csv export (hide by default)
        if ($classConfig->export_csv) {
            $GridFieldExportButton = $this->getGridFieldExportButton($config);
            $GridFieldExportButton->setExportColumns(ExcelImportExport::exportFieldsForClass($class));
        } else {
            $config->removeComponentsByType(GridFieldExportButton::class);
        }

        // Add/remove csv export (add by default)
        if ($classConfig->export_excel) {
            $ExcelGridFieldExportButton = new ExcelGridFieldExportButton('buttons-before-left');
            $config->addComponent($ExcelGridFieldExportButton);
        }

        // Rename import button
        $config->removeComponentsByType(GridFieldImportButton::class);
        if ($this->owner->showImportForm) {
            $ExcelGridFieldImportButton = new ExcelGridFieldImportButton('buttons-before-left');
            $ExcelGridFieldImportButton->setImportForm($this->owner->ImportForm());
            $ExcelGridFieldImportButton->setModalTitle(_t('ExcelImportExport.IMPORTFROMFILE', 'Import from a file'));
            $config->addComponent($ExcelGridFieldImportButton);
        }
    }

    /**
     * @param GridFieldConfig $config
     * @return GridFieldExportButton
     */
    protected function getGridFieldExportButton($config)
    {
        return $config->getComponentByType(GridFieldExportButton::class);
    }

    public function updateImportForm(Form $form)
    {
        /** @var ModelAdmin $owner */
        $owner = $this->owner;
        $class = $owner->modelClass;
        $classConfig = $owner->config();

        $modelSNG = singleton($class);
        $modelConfig = $modelSNG->config();
        $modelName = $modelSNG->i18n_singular_name();

        $fields = $form->Fields();

        $downloadSampleLink = $owner->Link(str_replace('\\', '-', $class) . '/downloadsample');
        $downloadSample = '<a href="' . $downloadSampleLink . '" class="no-ajax" target="_blank">' . _t(
            'ExcelImportExport.DownloadSample',
            'Download sample file'
        ) . '</a>';

        $file = $fields->dataFieldByName('_CsvFile');
        if ($file) {
            $csvDescription = ExcelImportExport::getValidExtensionsText();
            $csvDescription .= '. ' . $downloadSample;
            $file->setDescription($csvDescription);
            $file->getValidator()->setAllowedExtensions(ExcelImportExport::getValidExtensions());
        }

        // Hide by default, but allow on per class basis (opt-in)
        if ($classConfig->hide_replace_data && !$modelConfig->show_replace_data) {
            // This is way too dangerous and customers don't understand what this is most of the time
            $fields->removeByName("EmptyBeforeImport");
        }
        // If you cannot delete, you cannot empty
        if (!$modelSNG->canDelete()) {
            $fields->removeByName('EmptyBeforeImport');
        }

        // We moved the specs into a nice to use download sample button
        $fields->removeByName("SpecFor{$modelName}");

        // We can implement a custom handler
        $importHandlers = [];
        if ($modelSNG->hasMethod('listImportHandlers')) {
            $importHandlers = array_merge([
                'default' => _t('ExcelImportExport.DefaultHandler', 'Default import handler'),
            ], $modelSNG->listImportHandlers());

            $supportOnlyUpdate = [];
            foreach ($importHandlers as $class => $label) {
                if (class_exists($class) && method_exists($class, 'setOnlyUpdate')) {
                    $supportOnlyUpdate[] = $class;
                }
            }

            $form->Fields()->push($OnlyUpdateRecords = new CheckboxField("OnlyUpdateRecords", _t('ExcelImportExport.OnlyUpdateRecords', "Only update records")));
            $OnlyUpdateRecords->setAttribute("data-handlers", implode(",", $supportOnlyUpdate));
        }
        if (!empty($importHandlers)) {
            $form->Fields()->push($ImportHandler = new OptionsetField("ImportHandler", _t('ExcelImportExport.PleaseSelectImportHandler', "Please select the import handler"), $importHandlers));
            // Simply check of this is supported or not for the given handler (if not, disable it)
            $js = <<<JS
var cb=document.querySelector('#OnlyUpdateRecords');var accepted=cb.dataset.handlers.split(',');var item=([...this.querySelectorAll('input')].filter((input) => input.checked)[0]); cb.disabled=(item && accepted.includes(item.value)) ? '': 'disabled';
JS;
            $ImportHandler->setAttribute("onclick", $js);
        }

        $actions = $form->Actions();

        // Update import button
        $import = $actions->dataFieldByName('action_import');
        if ($import) {
            $import->setTitle(_t(
                'ExcelImportExport.ImportExcel',
                "Import from Excel"
            ));
            $import->removeExtraClass('btn-outline-secondary');
            $import->addExtraClass('btn-primary');
        }
    }
}


1			<?php
2
3			namespace LeKoala\ExcelImportExport\Extensions;
4
5			use SilverStripe\Forms\Form;
6			use SilverStripe\Core\Extension;
7			use SilverStripe\Admin\ModelAdmin;
8			use SilverStripe\Forms\CheckboxField;
9			use SilverStripe\Forms\OptionsetField;
10			use LeKoala\ExcelImportExport\ExcelBulkLoader;
11			use LeKoala\ExcelImportExport\ExcelImportExport;
12			use SilverStripe\Forms\GridField\GridFieldConfig;
13			use SilverStripe\Forms\GridField\GridFieldExportButton;
14			use SilverStripe\Forms\GridField\GridFieldImportButton;
15			use LeKoala\ExcelImportExport\ExcelGridFieldExportButton;
16			use LeKoala\ExcelImportExport\ExcelGridFieldImportButton;
17
18			/**
19			* Extends {@link ModelAdmin}. to bind new forms and features
20			*
21			* @author Koala
22			*/
23			class ModelAdminExcelExtension extends Extension
24			{
25			private static $allowed_actions = array(
			0 ignored issues – show introduced 2019-11-21 10:00 UTC by Report Bug Copy Issue Report The private property `$allowed_actions` is not used, and could be removed. Loading history...
26			'downloadsample'
27			);
28
29			public function onAfterInit()
30			{
31			$this->updateModelImporters();
32			}
33
34			/**
35			* Replace default model import with a predefined value
36			*
37			* @return void
38			*/
39			protected function updateModelImporters()
40			{
41			/* @var $owner ModelAdmin */
42			$owner = $this->owner;
43			$config = $this->owner->config();
44
45			// Overwrite model imports
46			$importerClasses = $config->get('model_importers');
47
48			if (is_null($importerClasses)) {
49			$models = $owner->getManagedModels();
50			foreach (array_keys($models) as $modelName) {
51			$importerClasses[$modelName] = ExcelBulkLoader::class;
52			}
53
54			$config->set('model_importers', $importerClasses);
55			}
56			}
57
58			public function downloadsample()
59			{
60			ExcelImportExport::sampleFileForClass($this->owner->modelClass);
61			}
62
63			public function updateGridFieldConfig(GridFieldConfig $config)
64			{
65			/** @var ModelAdmin $owner */
66			$owner = $this->owner;
67			$class = $owner->modelClass;
68			$classConfig = $owner->config();
69
70			// Add/remove csv export (hide by default)
71			if ($classConfig->export_csv) {
72			$GridFieldExportButton = $this->getGridFieldExportButton($config);
73			$GridFieldExportButton->setExportColumns(ExcelImportExport::exportFieldsForClass($class));
74			} else {
75			$config->removeComponentsByType(GridFieldExportButton::class);
76			}
77
78			// Add/remove csv export (add by default)
79			if ($classConfig->export_excel) {
80			$ExcelGridFieldExportButton = new ExcelGridFieldExportButton('buttons-before-left');
81			$config->addComponent($ExcelGridFieldExportButton);
82			}
83
84			// Rename import button
85			$config->removeComponentsByType(GridFieldImportButton::class);
86			if ($this->owner->showImportForm) {
87			$ExcelGridFieldImportButton = new ExcelGridFieldImportButton('buttons-before-left');
88			$ExcelGridFieldImportButton->setImportForm($this->owner->ImportForm());
89			$ExcelGridFieldImportButton->setModalTitle(_t('ExcelImportExport.IMPORTFROMFILE', 'Import from a file'));
90			$config->addComponent($ExcelGridFieldImportButton);
91			}
92			}
93
94			/**
95			* @param GridFieldConfig $config
96			* @return GridFieldExportButton
97			*/
98			protected function getGridFieldExportButton($config)
99			{
100			return $config->getComponentByType(GridFieldExportButton::class);
101			}
102
103			public function updateImportForm(Form $form)
104			{
105			/** @var ModelAdmin $owner */
106			$owner = $this->owner;
107			$class = $owner->modelClass;
108			$classConfig = $owner->config();
109
110			$modelSNG = singleton($class);
111			$modelConfig = $modelSNG->config();
112			$modelName = $modelSNG->i18n_singular_name();
113
114			$fields = $form->Fields();
115
116			$downloadSampleLink = $owner->Link(str_replace('\\', '-', $class) . '/downloadsample');
117			$downloadSample = '<a href="' . $downloadSampleLink . '" class="no-ajax" target="_blank">' . _t(
118			'ExcelImportExport.DownloadSample',
119			'Download sample file'
120			) . '</a>';
121
122			$file = $fields->dataFieldByName('_CsvFile');
123			if ($file) {
124			$csvDescription = ExcelImportExport::getValidExtensionsText();
125			$csvDescription .= '. ' . $downloadSample;
126			$file->setDescription($csvDescription);
127			$file->getValidator()->setAllowedExtensions(ExcelImportExport::getValidExtensions());
128			}
129
130			// Hide by default, but allow on per class basis (opt-in)
131			if ($classConfig->hide_replace_data && !$modelConfig->show_replace_data) {
132			// This is way too dangerous and customers don't understand what this is most of the time
133			$fields->removeByName("EmptyBeforeImport");
134			}
135			// If you cannot delete, you cannot empty
136			if (!$modelSNG->canDelete()) {
137			$fields->removeByName('EmptyBeforeImport');
138			}
139
140			// We moved the specs into a nice to use download sample button
141			$fields->removeByName("SpecFor{$modelName}");
142
143			// We can implement a custom handler
144			$importHandlers = [];
145			if ($modelSNG->hasMethod('listImportHandlers')) {
146			$importHandlers = array_merge([
147			'default' => _t('ExcelImportExport.DefaultHandler', 'Default import handler'),
148			], $modelSNG->listImportHandlers());
149
150			$supportOnlyUpdate = [];
151			foreach ($importHandlers as $class => $label) {
152			if (class_exists($class) && method_exists($class, 'setOnlyUpdate')) {
153			$supportOnlyUpdate[] = $class;
154			}
155			}
156
157			$form->Fields()->push($OnlyUpdateRecords = new CheckboxField("OnlyUpdateRecords", _t('ExcelImportExport.OnlyUpdateRecords', "Only update records")));
158			$OnlyUpdateRecords->setAttribute("data-handlers", implode(",", $supportOnlyUpdate));
159			}
160			if (!empty($importHandlers)) {
161			$form->Fields()->push($ImportHandler = new OptionsetField("ImportHandler", _t('ExcelImportExport.PleaseSelectImportHandler', "Please select the import handler"), $importHandlers));
162			// Simply check of this is supported or not for the given handler (if not, disable it)
163			$js = <<<JS
164			var cb=document.querySelector('#OnlyUpdateRecords');var accepted=cb.dataset.handlers.split(',');var item=([...this.querySelectorAll('input')].filter((input) => input.checked)[0]); cb.disabled=(item && accepted.includes(item.value)) ? '': 'disabled';
165			JS;
166			$ImportHandler->setAttribute("onclick", $js);
167			}
168
169			$actions = $form->Actions();
170
171			// Update import button
172			$import = $actions->dataFieldByName('action_import');
173			if ($import) {
174			$import->setTitle(_t(
175			'ExcelImportExport.ImportExcel',
176			"Import from Excel"
177			));
178			$import->removeExtraClass('btn-outline-secondary');
179			$import->addExtraClass('btn-primary');
180			}
181			}
182			}
183

lekoala / silverstripe-excel-import-export

Push — master ( 5e779f...172bf8 )

ModelAdminExcelExtension::updateImportForm() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like