<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Abstract class for the regex validation input transformations plugins
*
* @package PhpMyAdmin-Transformations
* @subpackage RegexValidation
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/* Get the transformations class */
require_once 'libraries/plugins/IOTransformationsPlugin.class.php';
/**
* Provides common methods for all of the regex validation
* input transformations plugins.
*
* @package PhpMyAdmin-Transformations
* @subpackage RegexValidation
*/
abstract class RegexValidationTransformationsPlugin extends IOTransformationsPlugin
{
/**
* Gets the transformation description of the specific plugin
*
* @return string
*/
public static function getInfo()
{
return __(
'Validates the string using regular expression '
. 'and performs insert only if string matches it. '
. 'The first option is the Regular Expression.'
);
}
/**
* Does the actual work of each specific transformations plugin.
*
* @param string $buffer text to be transformed
* @param array $options transformation options
* @param string $meta meta information
*
* @return string
*/
public function applyTransformation($buffer, $options = array(), $meta = '')
{
// reset properties of object
$this->reset();
if (!empty($options[0]) && !preg_match($options[0], $buffer)) {
$this->success = false;
$this->error = sprintf(
__('Validation failed for the input string %s.'), $buffer
);
}
return $buffer;
}
/* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
/**
* Gets the transformation name of the specific plugin
*
* @return string
*/
public static function getName()
{
return "Regex Validation";
}
}
?>