57 lines
1.3 KiB
PHP
57 lines
1.3 KiB
PHP
<?php
|
|
/**
|
|
* Abstract class for the SQL transformations plugins
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpMyAdmin\Plugins\Transformations\Abs;
|
|
|
|
use PhpMyAdmin\Html\Generator;
|
|
use PhpMyAdmin\Plugins\TransformationsPlugin;
|
|
use stdClass;
|
|
|
|
/**
|
|
* Provides common methods for all of the SQL transformations plugins.
|
|
*/
|
|
abstract class SQLTransformationsPlugin extends TransformationsPlugin
|
|
{
|
|
/**
|
|
* Gets the transformation description of the specific plugin
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function getInfo()
|
|
{
|
|
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 array $options transformation options
|
|
* @param stdClass|null $meta meta information
|
|
*
|
|
* @return string
|
|
*/
|
|
public function applyTransformation($buffer, array $options = [], ?stdClass $meta = null)
|
|
{
|
|
return Generator::formatSql($buffer);
|
|
}
|
|
|
|
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
|
|
|
|
/**
|
|
* Gets the transformation name of the specific plugin
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function getName()
|
|
{
|
|
return 'SQL';
|
|
}
|
|
}
|