/
SQLTransformationsPlugin.php
50 lines (42 loc) · 1.29 KB
/
SQLTransformationsPlugin.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<?php
/**
* Abstract class for the SQL transformations plugins
*/
declare(strict_types=1);
namespace PhpMyAdmin\Plugins\Transformations\Abs;
use PhpMyAdmin\FieldMetadata;
use PhpMyAdmin\Html\Generator;
use PhpMyAdmin\Plugins\TransformationsPlugin;
use function __;
/**
* Provides common methods for all of the SQL transformations plugins.
*/
abstract class SQLTransformationsPlugin extends TransformationsPlugin
{
/**
* Gets the transformation description of the specific plugin
*/
public static function getInfo(): string
{
return __('Formats text as SQL query with syntax highlighting.');
}
/**
* Does the actual work of each specific transformations plugin.
*
* @param string $buffer text to be transformed
* @param mixed[] $options transformation options
* @param FieldMetadata|null $meta meta information
*/
public function applyTransformation(string $buffer, array $options = [], FieldMetadata|null $meta = null): string
{
return Generator::formatSql($buffer);
}
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
/**
* Gets the transformation name of the specific plugin
*/
public static function getName(): string
{
return 'SQL';
}
}