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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Abstract class for the I/O transformations plugins
*
* @package PhpMyAdmin
*/
namespace PMA\libraries\plugins;
use PMA\libraries\plugins\TransformationsPlugin;
/**
* Provides a common interface that will have to be implemented
* by all of the Input/Output transformations plugins.
*
* @package PhpMyAdmin
*/
abstract class IOTransformationsPlugin extends TransformationsPlugin
{
// specifies whether transformation was successful or not
protected $success = true;
// to store the error message in case of failed transformations
protected $error = '';
/**
* 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(
$column,
$row_id,
$column_name_appendix,
$options,
$value,
$text_dir,
$tabindex,
$tabindex_for_value,
$idindex
) {
return '';
}
/**
* Returns the array of scripts (filename) required for plugin
* initialization and handling
*
* @return array javascripts to be included
*/
public function getScripts()
{
return array();
}
/**
* Returns the error message
*
* @return string error
*/
public function getError()
{
return $this->error;
}
/**
* Returns the success status
*
* @return bool
*/
public function isSuccess()
{
return $this->success;
}
/**
* Resets the object properties
*
* @return void
*/
public function reset()
{
$this->success = true;
$this->error = '';
}
}
|
