summaryrefslogtreecommitdiff
path: root/framework/Testing/Data/Analysis/TDbStatementAnalysis.php
blob: 46f9b745bc6a9686558ed279b79a2a32bc9d8d65 (plain)
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<?php
/**
 * IDbStatementAnalysis, TDbStatementAnalysisParameter,
 * TDbStatementAnalysis, TDbStatementClassification file.
 *
 * @author Yves Berkholz <godzilla80[at]gmx[dot]net>
 * @link http://www.pradosoft.com/
 * @copyright Copyright &copy; 2005-2010 PradoSoft
 * @license http://www.pradosoft.com/license/
 * @version $Id$
 * @package System.Testing.Data.Analysis
 */

	/**
	 * IDbStatementAnalysis interface
	 *
	 * @author Yves Berkholz <godzilla80[at]gmx[dot]net>
	 * @license http://www.pradosoft.com/license/
	 * @version $Id$
	 * @package System.Testing.Data.Analysis
	 * @since 4.0
	 */
	interface IDbStatementAnalysis
	{
		/**
		 * @param TDbStatementAnalysisParamete
		 * @return TDbStatementClassification
		 */
		public static function doClassificationAnalysis(TDbStatementAnalysisParameter $param);

		/**
		 * @param TDbStatementAnalysisParameter
		 * @return TDbStatementClassification
		 */
		public function getClassificationAnalysis(TDbStatementAnalysisParameter $param);

		/**
		 * @param string PDO drivername of connection
		 */
		public function setDriverName($value);

		/**
		 * @return string PDO drivername of connection
		 */
		public function getDriverName();
	}

	/**
	 * TDbStatementAnalysisParameter class
	 *
	 *
	 * @author Yves Berkholz <godzilla80[at]gmx[dot]net>
	 * @license http://www.pradosoft.com/license/
	 * @version $Id$
	 * @package System.Testing.Data.Analysis
	 * @since 4.0
	 */
	class TDbStatementAnalysisParameter
	{
		/**
		 * @var string The SQL statement that should be analysed
		 */
		protected $_statement = null;

		/**
		 * TDbStatementClassification Defaults to 'UNKNOWN'
		 */
		protected $_defaultClassification = TDbStatementClassification::UNKNOWN;

		/**
		 * string|null PDO drivername of connection
		 */
		protected  $_drivername	= null;

		/**
		 * @param string The SQL statement that should be analysed
		 * @param TDbStatementClassification
		 * @param string|null PDO drivername of connection
		 */
		public function __construct($statement='', $defaultClassification=null, $drivername=null)
		{
			$this->setStatement($statement);
			$this->setDefaultClassification($defaultClassification);
			$this->setDriverName($drivername);
		}

		/**
		 * @param string The SQL statement that should be analysed
		 */
		public function setStatement($value)
		{
			$this->_statement = (string)$value;
		}

		/**
		 * @return string The SQL statement that should be analysed
		 */
		public function getStatement()
		{
			return $this->_statement;
		}

		/**
		 * @param string|null PDO drivername of connection
		 */
		public function setDriverName($value)
		{
			$this->_drivername = ($value===null) ? null : (string)$value;
		}

		/**
		 * @return string|null PDO drivername of connection
		 */
		public function getDriverName()
		{
			return $this->_drivername;
		}

		/**
		 * @param TDbStatementClassification Defaults to 'UNKNOWN'
		 */
		public function setDefaultClassification($value)
		{
			if($value!==null)
				$this->_defaultClassification = (string)$value;
			else
				$this->_defaultClassification = TDbStatementClassification::UNKNOWN;
		}

		/**
		 * @return TDbStatementClassification
		 */
		public function getDefaultClassification()
		{
			return $this->_defaultClassification;
		}
	}

	/**
	 * TDbStatementAnalysis class
	 *
	 * Basic "dummy" implementation allways return {@link TDbStatementAnalysisParameter::getDefaultClassification DefaultClassification}
	 *
	 * @author Yves Berkholz <godzilla80[at]gmx[dot]net>
	 * @license http://www.pradosoft.com/license/
	 * @version $Id$
	 * @package System.Testing.Data.Analysis
	 * @since 4.0
	 */
	class TDbStatementAnalysis implements IDbStatementAnalysis
	{
		/**
		 * @var string|null PDO drivername of connection
		 */
		protected $_drivername = null;

		/**
		 * @param string|null PDO drivername of connection
		 */
		public function setDriverName($value)
		{
			$this->_drivername = ($value===null) ? null : (string)$value;
		}

		/**
		 * @return string|null PDO drivername of connection
		 */
		public function getDriverName()
		{
			return $this->_drivername;
		}

		/**
		 * @param TDbStatementAnalysisParamete
		 * @return TDbStatementClassification
		 */
		public static function doClassificationAnalysis(TDbStatementAnalysisParameter $param)
		{
			return $param->getDefaultClassification();
		}

		/**
		 * @param TDbStatementAnalysisParameter
		 * @return TDbStatementClassification
		 */
		public function getClassificationAnalysis(TDbStatementAnalysisParameter $param)
		{
			return $param->getDefaultClassification();
		}
	}

	/**
	 * TDbStatementClassification
	 *
	 * @author Yves Berkholz <godzilla80[at]gmx[dot]net>
	 * @license http://www.pradosoft.com/license/
	 * @version $Id$
	 * @package System.Testing.Data.Analysis
	 * @since 4.0
	 */
	class TDbStatementClassification extends TEnumerable
	{
		/**
		 * Structured Query Language
		 */
		const SQL = 'SQL';

		/**
		 * Data Definition Language
		 */
		const DDL = 'DDL';

		/**
		 * Data Manipulation Language
		 */
		const DML = 'DML';

		/**
		 * Data Control Language
		 */
		const DCL = 'DCL';

		/**
		 * Transaction Control Language
		 */
		const TCL = 'TCL';

		/**
		 * classification depends on subsequent statement(s)
		 */
		const CONTEXT = 'CONTEXT';

		/**
		 * unable to detect real classification or multiple possibilities
		 */
		const UNKNOWN = 'UNKNOWN';
	}
?>