blob: 5fa641a764fc012e589249f6cd23697514f704fe (
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
|
<?php
/**
* TSqlMapConfig class file.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @link https://github.com/pradosoft/prado
* @copyright Copyright © 2005-2015 The PRADO Group
* @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
* @package System.Data.SqlMap
*/
Prado::using('System.Data.TDataSourceConfig');
/**
* TSqlMapConfig module configuration class.
*
* Database connection and TSqlMapManager configuration.
*
* @author Wei Zhuo <weizho[at]gmail[dot]com>
* @package System.Data.SqlMap
* @since 3.1
*/
class TSqlMapConfig extends TDataSourceConfig
{
private $_configFile;
private $_sqlmap;
private $_enableCache=false;
/**
* File extension of external configuration file
*/
const CONFIG_FILE_EXT='.xml';
/**
* @return string module ID + configuration file path.
*/
private function getCacheKey()
{
return $this->getID().$this->getConfigFile();
}
/**
* Deletes the configuration cache.
*/
public function clearCache()
{
$cache = $this->getApplication()->getCache();
if($cache !== null) {
$cache->delete($this->getCacheKey());
}
}
/**
* Create and configure the data mapper using sqlmap configuration file.
* Or if cache is enabled and manager already cached load from cache.
* If cache is enabled, the data mapper instance is cached.
*
* @return TSqlMapManager SqlMap manager instance
* @since 3.1.7
*/
public function getSqlMapManager() {
Prado::using('System.Data.SqlMap.TSqlMapManager');
if(($manager = $this->loadCachedSqlMapManager())===null)
{
$manager = new TSqlMapManager($this->getDbConnection());
if(strlen($file=$this->getConfigFile()) > 0)
{
$manager->configureXml($file);
$this->cacheSqlMapManager($manager);
}
}
elseif($this->getConnectionID() !== '') {
$manager->setDbConnection($this->getDbConnection());
}
return $manager;
}
/**
* Saves the current SqlMap manager to cache.
* @return boolean true if SqlMap manager was cached, false otherwise.
*/
protected function cacheSqlMapManager($manager)
{
if($this->getEnableCache())
{
$cache = $this->getApplication()->getCache();
if($cache !== null) {
$dependencies = null;
if($this->getApplication()->getMode() !== TApplicationMode::Performance)
$dependencies = $manager->getCacheDependencies();
return $cache->set($this->getCacheKey(), $manager, 0, $dependencies);
}
}
return false;
}
/**
* Loads SqlMap manager from cache.
* @return TSqlMapManager SqlMap manager intance if load was successful, null otherwise.
*/
protected function loadCachedSqlMapManager()
{
if($this->getEnableCache())
{
$cache = $this->getApplication()->getCache();
if($cache !== null)
{
$manager = $cache->get($this->getCacheKey());
if($manager instanceof TSqlMapManager)
return $manager;
}
}
return null;
}
/**
* @return string SqlMap configuration file.
*/
public function getConfigFile()
{
return $this->_configFile;
}
/**
* @param string external configuration file in namespace format. The file
* extension must be '.xml'.
* @throws TConfigurationException if the file is invalid.
*/
public function setConfigFile($value)
{
if(is_file($value))
$this->_configFile=$value;
else
{
$file = Prado::getPathOfNamespace($value,self::CONFIG_FILE_EXT);
if($file === null || !is_file($file))
throw new TConfigurationException('sqlmap_configfile_invalid',$value);
else
$this->_configFile = $file;
}
}
/**
* Set true to cache sqlmap instances.
* @param boolean true to cache sqlmap instance.
*/
public function setEnableCache($value)
{
$this->_enableCache = TPropertyValue::ensureBoolean($value);
}
/**
* @return boolean true if configuration should be cached, false otherwise.
*/
public function getEnableCache()
{
return $this->_enableCache;
}
/**
* @return TSqlMapGateway SqlMap gateway instance.
*/
protected function createSqlMapGateway()
{
return $this->getSqlMapManager()->getSqlmapGateway();
}
/**
* Initialize the sqlmap if necessary, returns the TSqlMapGateway instance.
* @return TSqlMapGateway SqlMap gateway instance.
*/
public function getClient()
{
if($this->_sqlmap===null )
$this->_sqlmap=$this->createSqlMapGateway();
return $this->_sqlmap;
}
}
|
