blob: ebe948d8ccb452520727e465df7a1b6c9db11feb (
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
|
<?php
/**
* TDataSourceConfig class file.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005-2014 PradoSoft
* @license http://www.pradosoft.com/license/
* @package Prado\Data
*/
namespace Prado\Data;
Prado::using('System.Data.TDbConnection');
/**
* TDataSourceConfig module class provides <module> configuration for database connections.
*
* Example usage: mysql connection
* <code>
* <modules>
* <module id="db1">
* <database ConnectionString="mysqli:host=localhost;dbname=test"
* username="dbuser" password="dbpass" />
* </module>
* </modules>
* </code>
*
* Usage in php:
* <code>
* class Home extends TPage
* {
* function onLoad($param)
* {
* $db = $this->Application->Modules['db1']->DbConnection;
* $db->createCommand('...'); //...
* }
* }
* </code>
*
* The properties of <connection> are those of the class TDbConnection.
* Set {@link setConnectionClass} attribute for a custom database connection class
* that extends the TDbConnection class.
*
* @author Wei Zhuo <weizho[at]gmail[dot]com>
* @package Prado\Data
* @since 3.1
*/
class TDataSourceConfig extends TModule
{
private $_connID='';
private $_conn;
private $_connClass='System.Data.TDbConnection';
/**
* Initalize the database connection properties from attributes in <database> tag.
* @param TXmlDocument xml configuration.
*/
public function init($xml)
{
if($this->getApplication()->getConfigurationType()==TApplication::CONFIG_TYPE_PHP)
{
if(isset($xml['database']) && is_array($xml['database']))
{
$db=$this->getDbConnection();
foreach($xml['database'] as $name=>$value)
$db->setSubProperty($name,$value);
}
}
else
{
if($prop=$xml->getElementByTagName('database'))
{
$db=$this->getDbConnection();
foreach($prop->getAttributes() as $name=>$value)
$db->setSubproperty($name,$value);
}
}
}
/**
* The module ID of another TDataSourceConfig. The {@link getDbConnection DbConnection}
* property of this configuration will equal to {@link getDbConnection DbConnection}
* of the given TDataSourceConfig module.
* @param string module ID.
*/
public function setConnectionID($value)
{
$this->_connID=$value;
}
/**
* @return string connection module ID.
*/
public function getConnectionID()
{
return $this->_connID;
}
/**
* Gets the TDbConnection from another module if {@link setConnectionID ConnectionID}
* is supplied and valid. Otherwise, a connection of type given by
* {@link setConnectionClass ConnectionClass} is created.
* @return TDbConnection database connection.
*/
public function getDbConnection()
{
if($this->_conn===null)
{
if($this->_connID!=='')
$this->_conn = $this->findConnectionByID($this->getConnectionID());
else
$this->_conn = Prado::createComponent($this->getConnectionClass());
}
return $this->_conn;
}
/**
* Alias for getDbConnection().
* @return TDbConnection database connection.
*/
public function getDatabase()
{
return $this->getDbConnection();
}
/**
* @param string Database connection class name to be created.
*/
public function getConnectionClass()
{
return $this->_connClass;
}
/**
* The database connection class name to be created when {@link getDbConnection}
* method is called <b>and</b> {@link setConnectionID ConnectionID} is null. The
* {@link setConnectionClass ConnectionClass} property must be set before
* calling {@link getDbConnection} if you wish to create the connection using the
* given class name.
* @param string Database connection class name.
* @throws TConfigurationException when database connection is already established.
*/
public function setConnectionClass($value)
{
if($this->_conn!==null)
throw new TConfigurationException('datasource_dbconnection_exists', $value);
$this->_connClass=$value;
}
/**
* Finds the database connection instance from the Application modules.
* @param string Database connection module ID.
* @return TDbConnection database connection.
* @throws TConfigurationException when module is not of TDbConnection or TDataSourceConfig.
*/
protected function findConnectionByID($id)
{
$conn = $this->getApplication()->getModule($id);
if($conn instanceof TDbConnection)
return $conn;
else if($conn instanceof TDataSourceConfig)
return $conn->getDbConnection();
else
throw new TConfigurationException('datasource_dbconnection_invalid',$id);
}
}
|
