Initial commit

pma/libraries/classes/Plugins/Import/AbstractImportCsv.php

@@ -0,0 +1,88 @@
+<?php
+/**
+ * Super class of CSV import plugins for phpMyAdmin
+ */
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\Plugins\Import;
+
+use PhpMyAdmin\Plugins\ImportPlugin;
+use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup;
+use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyRootGroup;
+use PhpMyAdmin\Properties\Options\Items\BoolPropertyItem;
+use PhpMyAdmin\Properties\Options\Items\TextPropertyItem;
+use PhpMyAdmin\Properties\Plugins\ImportPluginProperties;
+
+/**
+ * Super class of the import plugins for the CSV format
+ */
+abstract class AbstractImportCsv extends ImportPlugin
+{
+    /**
+     * Sets the import plugin properties.
+     * Called in the constructor.
+     *
+     * @return OptionsPropertyMainGroup|void object of the plugin
+     */
+    protected function setProperties()
+    {
+        $importPluginProperties = new ImportPluginProperties();
+        $importPluginProperties->setOptionsText(__('Options'));
+
+        // create the root group that will be the options field for
+        // $importPluginProperties
+        // this will be shown as "Format specific options"
+        $importSpecificOptions = new OptionsPropertyRootGroup(
+            'Format Specific Options'
+        );
+
+        // general options main group
+        $generalOptions = new OptionsPropertyMainGroup('general_opts');
+
+        // create common items and add them to the group
+        $leaf = new BoolPropertyItem(
+            'replace',
+            __(
+                'Update data when duplicate keys found on import (add ON DUPLICATE '
+                . 'KEY UPDATE)'
+            )
+        );
+        $generalOptions->addProperty($leaf);
+        $leaf = new TextPropertyItem(
+            'terminated',
+            __('Columns separated with:')
+        );
+        $leaf->setSize(2);
+        $generalOptions->addProperty($leaf);
+        $leaf = new TextPropertyItem(
+            'enclosed',
+            __('Columns enclosed with:')
+        );
+        $leaf->setSize(2);
+        $leaf->setLen(2);
+        $generalOptions->addProperty($leaf);
+        $leaf = new TextPropertyItem(
+            'escaped',
+            __('Columns escaped with:')
+        );
+        $leaf->setSize(2);
+        $leaf->setLen(2);
+        $generalOptions->addProperty($leaf);
+        $leaf = new TextPropertyItem(
+            'new_line',
+            __('Lines terminated with:')
+        );
+        $leaf->setSize(2);
+        $generalOptions->addProperty($leaf);
+
+        // add the main group to the root group
+        $importSpecificOptions->addProperty($generalOptions);
+
+        // set the options for the import plugin property item
+        $importPluginProperties->setOptions($importSpecificOptions);
+        $this->properties = $importPluginProperties;
+
+        return $generalOptions;
+    }
+}