summaryrefslogtreecommitdiff
path: root/framework/Data/DataGateway/TTableGateway.php
blob: d1b8264a705a98e717e1a77c17fd3cabea4f8698 (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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
<?php
/**
 * TTableGateway class file.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @link https://github.com/pradosoft/prado
 * @copyright Copyright &copy; 2005-2016 The PRADO Group
 * @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
 * @version $Id$
 * @package System.Data.DataGateway
 */

/**
 * Loads the data gateway command builder and sql criteria.
 */
Prado::using('System.Data.DataGateway.TSqlCriteria');
Prado::using('System.Data.DataGateway.TDataGatewayCommand');

/**
 * TTableGateway class provides several find methods to get data from the database
 * and update, insert, and delete methods.
 *
 * Each method maps the input parameters into a SQL call and executes the SQL
 * against a database connection. The TTableGateway is stateless
 * (with respect to the data and data objects), as its role is to push data back and forth.
 *
 * Example usage:
 * <code>
 * //create a connection
 * $dsn = 'pgsql:host=localhost;dbname=test';
 * $conn = new TDbConnection($dsn, 'dbuser','dbpass');
 *
 * //create a table gateway for table/view named 'address'
 * $table = new TTableGateway('address', $conn);
 *
 * //insert a new row, returns last insert id (if applicable)
 * $id = $table->insert(array('name'=>'wei', 'phone'=>'111111'));
 *
 * $record1 = $table->findByPk($id); //find inserted record
 *
 * //finds all records, returns an iterator
 * $records = $table->findAll();
 * print_r($records->readAll());
 *
 * //update the row
 * $table->updateByPk($record1, $id);
 * </code>
 *
 * All methods that may return more than one row of data will return an
 * TDbDataReader iterator.
 *
 * The OnCreateCommand event is raised when a command is prepared and parameter
 * binding is completed. The parameter object is a TDataGatewayEventParameter of which the
 * {@link TDataGatewayEventParameter::getCommand Command} property can be
 * inspected to obtain the sql query to be executed.
 *
 * The OnExecuteCommand	event is raised when a command is executed and the result
 * from the database was returned. The parameter object is a
 * TDataGatewayResultEventParameter of which the
 * {@link TDataGatewayEventParameter::getResult Result} property contains
 * the data return from the database. The data returned can be changed
 * by setting the {@link TDataGatewayEventParameter::setResult Result} property.
 *
 * <code>
 * $table->OnCreateCommand[] = 'log_it'; //any valid PHP callback statement
 * $table->OnExecuteCommand[] = array($obj, 'method_name'); // calls 'method_name' on $obj
 *
 * function log_it($sender, $param)
 * {
 *     var_dump($param); //TDataGatewayEventParameter object.
 * }
 * </code>
 *
 * @author Wei Zhuo <weizho[at]gmail[dot]com>
 * @version $Id$
 * @package System.Data.DataGateway
 * @since 3.1
 */
class TTableGateway extends TComponent
{
	private $_command;
	private $_connection;

	/**
	 * Creates a new generic table gateway for a given table or view name
	 * and a database connection.
	 * @param string|TDbTableInfo table or view name or table information.
	 * @param TDbConnection database connection.
	 */
	public function __construct($table,$connection)
	{
		$this->_connection=$connection;
		if(is_string($table))
			$this->setTableName($table);
		else if($table instanceof TDbTableInfo)
			$this->setTableInfo($table);
		else
			throw new TDbException('dbtablegateway_invalid_table_info');
	}

	/**
	 * @param TDbTableInfo table or view information.
	 */
	protected function setTableInfo($tableInfo)
	{
		$builder = $tableInfo->createCommandBuilder($this->getDbConnection());
		$this->initCommandBuilder($builder);
	}

	/**
	 * Sets up the command builder for the given table.
	 * @param string table or view name.
	 */
	protected function setTableName($tableName)
	{
		Prado::using('System.Data.Common.TDbMetaData');
		$meta = TDbMetaData::getInstance($this->getDbConnection());
		$this->initCommandBuilder($meta->createCommandBuilder($tableName));
	}

	public function getTableInfo()
	{
		return $this->getCommand()->getTableInfo();
	}

	public function getTableName()
	{
		return $this->getTableInfo()->getTableName();
	}

	/**
	 * @param TDbCommandBuilder database specific command builder.
	 */
	protected function initCommandBuilder($builder)
	{
		$this->_command = new TDataGatewayCommand($builder);
		$this->_command->OnCreateCommand[] = array($this, 'onCreateCommand');
		$this->_command->OnExecuteCommand[] = array($this, 'onExecuteCommand');
	}

	/**
	 * Raised when a command is prepared and parameter binding is completed.
	 * The parameter object is TDataGatewayEventParameter of which the
	 * {@link TDataGatewayEventParameter::getCommand Command} property can be
	 * inspected to obtain the sql query to be executed.
	 * @param TDataGatewayCommand originator $sender
	 * @param TDataGatewayEventParameter
	 */
	public function onCreateCommand($sender, $param)
	{
		$this->raiseEvent('OnCreateCommand', $this, $param);
	}

	/**
	 * Raised when a command is executed and the result from the database was returned.
	 * The parameter object is TDataGatewayResultEventParameter of which the
	 * {@link TDataGatewayEventParameter::getResult Result} property contains
	 * the data return from the database. The data returned can be changed
	 * by setting the {@link TDataGatewayEventParameter::setResult Result} property.
	 * @param TDataGatewayCommand originator $sender
	 * @param TDataGatewayResultEventParameter
	 */
	public function onExecuteCommand($sender, $param)
	{
		$this->raiseEvent('OnExecuteCommand', $this, $param);
	}

	/**
	 * @return TDataGatewayCommand command builder and executor.
	 */
	protected function getCommand()
	{
		return $this->_command;
	}

	/**
	 * @return TDbConnection database connection.
	 */
	public function getDbConnection()
	{
		return $this->_connection;
	}

	/**
	 * Execute arbituary sql command with binding parameters.
	 * @param string SQL query string.
	 * @param array binding parameters, positional or named.
	 * @return array query results.
	 */
	public function findBySql($sql, $parameters=array())
	{
		$args = func_num_args() > 1 ? array_slice(func_get_args(),1) : null;
		$criteria = $this->getCriteria($sql,$parameters, $args);
		return $this->getCommand()->findBySql($criteria);
	}

	/**
	 * Execute arbituary sql command with binding parameters.
	 * @param string SQL query string.
	 * @param array binding parameters, positional or named.
	 * @return TDbDataReader query results.
	 */
	public function findAllBySql($sql, $parameters=array())
	{
		$args = func_num_args() > 1 ? array_slice(func_get_args(),1) : null;
		$criteria = $this->getCriteria($sql,$parameters, $args);
		return $this->getCommand()->findAllBySql($criteria);
	}

	/**
	 * Find one single record that matches the criteria.
	 *
	 * Usage:
	 * <code>
	 * $table->find('username = :name AND password = :pass',
	 * 					array(':name'=>$name, ':pass'=>$pass));
	 * $table->find('username = ? AND password = ?', array($name, $pass));
	 * $table->find('username = ? AND password = ?', $name, $pass);
	 * //$criteria is of TSqlCriteria
	 * $table->find($criteria); //the 2nd parameter for find() is ignored.
	 * </code>
	 *
	 * @param string|TSqlCriteria SQL condition or criteria object.
	 * @param mixed parameter values.
	 * @return array matching record object.
	 */
	public function find($criteria, $parameters=array())
	{
		$args = func_num_args() > 1 ? array_slice(func_get_args(),1) : null;
		$criteria = $this->getCriteria($criteria,$parameters, $args);
		return $this->getCommand()->find($criteria);
	}

	/**
	 * Accepts same parameters as find(), but returns TDbDataReader instead.
	 * @param string|TSqlCriteria SQL condition or criteria object.
	 * @param mixed parameter values.
	 * @return TDbDataReader matching records.
	 */
	public function findAll($criteria=null, $parameters=array())
	{
		$args = func_num_args() > 1 ? array_slice(func_get_args(),1) : null;
		if($criteria!==null)
			$criteria = $this->getCriteria($criteria,$parameters, $args);
		return $this->getCommand()->findAll($criteria);
	}

	/**
	 * Find one record using only the primary key or composite primary keys. Usage:
	 *
	 * <code>
	 * $table->findByPk($primaryKey);
	 * $table->findByPk($key1, $key2, ...);
	 * $table->findByPk(array($key1,$key2,...));
	 * </code>
	 *
	 * @param mixed primary keys
	 * @return array matching record.
	 */
	public function findByPk($keys)
	{
		if(func_num_args() > 1)
			$keys = func_get_args();
		return $this->getCommand()->findByPk($keys);
	}

	/**
	 * Similar to findByPk(), but returns TDbDataReader instead.
	 *
	 * For scalar primary keys:
	 * <code>
	 * $table->findAllByPk($key1, $key2, ...);
	 * $table->findAllByPk(array($key1, $key2, ...));
	 * </code>
	 *
	 * For composite keys:
	 * <code>
	 * $table->findAllByPk(array($key1, $key2), array($key3, $key4), ...);
	 * $table->findAllByPk(array(array($key1, $key2), array($key3, $key4), ...));
	 * </code>
	 * @param mixed primary keys
	 * @return TDbDataReader data reader.
	 */
	public function findAllByPks($keys)
	{
		if(func_num_args() > 1)
			$keys = func_get_args();
		return $this->getCommand()->findAllByPk($keys);
	}

	/**
	 * Delete records from the table with condition given by $where and
	 * binding values specified by $parameter argument.
	 * This method uses additional arguments as $parameters. E.g.
	 * <code>
	 * $table->delete('age > ? AND location = ?', $age, $location);
	 * </code>
	 * @param string delete condition.
	 * @param array condition parameters.
	 * @return integer number of records deleted.
	 */
	public function deleteAll($criteria, $parameters=array())
	{
		$args = func_num_args() > 1 ? array_slice(func_get_args(),1) : null;
		$criteria = $this->getCriteria($criteria,$parameters, $args);
		return $this->getCommand()->delete($criteria);
	}

	/**
	 * Delete records by primary key. Usage:
	 *
	 * <code>
	 * $table->deleteByPk($primaryKey); //delete 1 record
	 * $table->deleteByPk($key1,$key2,...); //delete multiple records
	 * $table->deleteByPk(array($key1,$key2,...)); //delete multiple records
	 * </code>
	 *
	 * For composite primary keys (determined from the table definitions):
	 * <code>
	 * $table->deleteByPk(array($key1,$key2)); //delete 1 record
	 *
	 * //delete multiple records
	 * $table->deleteByPk(array($key1,$key2), array($key3,$key4),...);
	 *
	 * //delete multiple records
	 * $table->deleteByPk(array( array($key1,$key2), array($key3,$key4), .. ));
	 * </code>
	 *
	 * @param mixed primary key values.
	 * @return int number of records deleted.
	 */
	public function deleteByPk($keys)
	{
		if(func_num_args() > 1)
			$keys = func_get_args();
		return $this->getCommand()->deleteByPk($keys);
	}

	/**
	 * Alias for deleteByPk()
	 */
	public function deleteAllByPks($keys)
	{
		if(func_num_args() > 1)
			$keys = func_get_args();
		return $this->deleteByPk($keys);
	}

	/**
	 * Find the number of records.
	 * @param string|TSqlCriteria SQL condition or criteria object.
	 * @param mixed parameter values.
	 * @return int number of records.
	 */
	public function count($criteria=null,$parameters=array())
	{
		$args = func_num_args() > 1 ? array_slice(func_get_args(),1) : null;
		if($criteria!==null)
			$criteria = $this->getCriteria($criteria,$parameters, $args);
		return $this->getCommand()->count($criteria);
	}

	/**
	 * Updates the table with new name-value pair $data. Each array key must
	 * correspond to a column name in the table. The update condition is
	 * specified by the $where argument and additional binding values can be
	 * specified using the $parameter argument.
	 * This method uses additional arguments as $parameters. E.g.
	 * <code>
	 * $gateway->update($data, 'age > ? AND location = ?', $age, $location);
	 * </code>
	 * @param array new record data.
	 * @param string update condition
	 * @param array additional binding name-value pairs.
	 * @return integer number of records updated.
	 */
	public function update($data, $criteria, $parameters=array())
	{
		$args = func_num_args() > 2 ? array_slice(func_get_args(),2) : null;
		$criteria = $this->getCriteria($criteria,$parameters, $args);
		return $this->getCommand()->update($data, $criteria);
	}

	/**
	 * Inserts a new record into the table. Each array key must
	 * correspond to a column name in the table unless a null value is permitted.
	 * @param array new record data.
	 * @return mixed last insert id if one column contains a serial or sequence,
	 * otherwise true if command executes successfully and affected 1 or more rows.
	 */
	public function insert($data)
	{
		return $this->getCommand()->insert($data);
	}

	/**
	 * @return mixed last insert id, null if none is found.
	 */
	public function getLastInsertId()
	{
		return $this->getCommand()->getLastInsertId();
	}

	/**
	 * Create a new TSqlCriteria object from a string $criteria. The $args
	 * are additional parameters and are used in place of the $parameters
	 * if $parameters is not an array and $args is an arrary.
	 * @param string|TSqlCriteria sql criteria
	 * @param mixed parameters passed by the user.
	 * @param array additional parameters obtained from function_get_args().
	 * @return TSqlCriteria criteria object.
	 */
	protected function getCriteria($criteria, $parameters, $args)
	{
		if(is_string($criteria))
		{
			$useArgs = !is_array($parameters) && is_array($args);
			return new TSqlCriteria($criteria,$useArgs ? $args : $parameters);
		}
		else if($criteria instanceof TSqlCriteria)
			return $criteria;
		else
			throw new TDbException('dbtablegateway_invalid_criteria');
	}

	/**
	 * Dynamic find method using parts of method name as search criteria.
	 * Method name starting with "findBy" only returns 1 record.
	 * Method name starting with "findAllBy" returns 0 or more records.
	 * Method name starting with "deleteBy" deletes records by the trail criteria.
	 * The condition is taken as part of the method name after "findBy", "findAllBy"
	 * or "deleteBy".
	 *
	 * The following are equivalent:
	 * <code>
	 * $table->findByName($name)
	 * $table->find('Name = ?', $name);
	 * </code>
	 * <code>
	 * $table->findByUsernameAndPassword($name,$pass); // OR may be used
	 * $table->findBy_Username_And_Password($name,$pass); // _OR_ may be used
	 * $table->find('Username = ? AND Password = ?', $name, $pass);
	 * </code>
	 * <code>
	 * $table->findAllByAge($age);
	 * $table->findAll('Age = ?', $age);
	 * </code>
	 * <code>
	 * $table->deleteAll('Name = ?', $name);
	 * $table->deleteByName($name);
	 * </code>
	 * @return mixed single record if method name starts with "findBy", 0 or more records
	 * if method name starts with "findAllBy"
	 */
	public function __call($method,$args)
	{
		$delete =false;
		if($findOne = substr(strtolower($method),0,6)==='findby')
			$condition = $method[6]==='_' ? substr($method,7) : substr($method,6);
		else if(substr(strtolower($method),0,9)==='findallby')
			$condition = $method[9]==='_' ? substr($method,10) : substr($method,9);
		else if($delete = substr(strtolower($method),0,8)==='deleteby')
			$condition = $method[8]==='_' ? substr($method,9) : substr($method,8);
		else if($delete = substr(strtolower($method),0,11)==='deleteallby')
			$condition = $method[11]==='_' ? substr($method,12) : substr($method,11);
		else
			return null;

		$criteria = $this->getCommand()->createCriteriaFromString($method, $condition, $args);
		if($delete)
			return $this->deleteAll($criteria);
		else
			return $findOne ? $this->find($criteria) : $this->findAll($criteria);
	}
}