Initial commit

pma/libraries/classes/Plugins/Transformations/Abs/TextFileUploadTransformationsPlugin.php

@@ -0,0 +1,98 @@
+<?php
+/**
+ * Abstract class for the text file upload input transformations plugins
+ */
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\Plugins\Transformations\Abs;
+
+use PhpMyAdmin\Plugins\IOTransformationsPlugin;
+use stdClass;
+use function htmlspecialchars;
+
+/**
+ * Provides common methods for all of the text file upload
+ * input transformations plugins.
+ */
+abstract class TextFileUploadTransformationsPlugin extends IOTransformationsPlugin
+{
+    /**
+     * Gets the transformation description of the specific plugin
+     *
+     * @return string
+     */
+    public static function getInfo()
+    {
+        return __(
+            'File upload functionality for TEXT columns. '
+            . 'It does not have a textarea for input.'
+        );
+    }
+
+    /**
+     * Does the actual work of each specific transformations plugin.
+     *
+     * @param string        $buffer  text to be transformed
+     * @param array         $options transformation options
+     * @param stdClass|null $meta    meta information
+     *
+     * @return string
+     */
+    public function applyTransformation($buffer, array $options = [], ?stdClass $meta = null)
+    {
+        return $buffer;
+    }
+
+    /**
+     * Returns the html for input field to override default textarea.
+     * Note: Return empty string if default textarea is required.
+     *
+     * @param array  $column               column details
+     * @param int    $row_id               row number
+     * @param string $column_name_appendix the name attribute
+     * @param array  $options              transformation options
+     * @param string $value                Current field value
+     * @param string $text_dir             text direction
+     * @param int    $tabindex             tab index
+     * @param int    $tabindex_for_value   offset for the values tabindex
+     * @param int    $idindex              id index
+     *
+     * @return string the html for input field
+     */
+    public function getInputHtml(
+        array $column,
+        $row_id,
+        $column_name_appendix,
+        array $options,
+        $value,
+        $text_dir,
+        $tabindex,
+        $tabindex_for_value,
+        $idindex
+    ) {
+        $html = '';
+        if (! empty($value)) {
+            $html = '<input type="hidden" name="fields_prev' . $column_name_appendix
+                . '" value="' . htmlspecialchars($value) . '">';
+            $html .= '<input type="hidden" name="fields' . $column_name_appendix
+                . '" value="' . htmlspecialchars($value) . '">';
+        }
+        $html .= '<input type="file" name="fields_upload'
+            . $column_name_appendix . '">';
+
+        return $html;
+    }
+
+    /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
+
+    /**
+     * Gets the transformation name of the specific plugin
+     *
+     * @return string
+     */
+    public static function getName()
+    {
+        return 'Text file upload';
+    }
+}