blob: f2c7e0b61677d064d3f4b149893b5149c59834f7 (
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
|
<?php
/**
* TActiveRecordConfig 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.ActiveRecord
*/
Prado::using('System.Data.TDataSourceConfig');
Prado::using('System.Data.ActiveRecord.TActiveRecordManager');
/**
* TActiveRecordConfig module configuration class.
*
* Database configuration for the default ActiveRecord manager instance.
*
* Example: application.xml configuration
* <code>
* <modules>
* <module class="System.Data.ActiveRecord.TActiveRecordConfig" EnableCache="true">
* <database ConnectionString="mysql:host=localhost;dbname=test"
* Username="dbuser" Password="dbpass" />
* </module>
* </modules>
* </code>
*
* MySQL database definition:
* <code>
* CREATE TABLE `blogs` (
* `blog_id` int(10) unsigned NOT NULL auto_increment,
* `blog_name` varchar(255) NOT NULL,
* `blog_author` varchar(255) NOT NULL,
* PRIMARY KEY (`blog_id`)
* ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
* </code>
*
* Record php class:
* <code>
* class Blogs extends TActiveRecord
* {
* public $blog_id;
* public $blog_name;
* public $blog_author;
*
* public static function finder($className=__CLASS__)
* {
* return parent::finder($className);
* }
* }
* </code>
*
* Usage example:
* <code>
* class Home extends TPage
* {
* function onLoad($param)
* {
* $blogs = Blogs::finder()->findAll();
* print_r($blogs);
* }
* }
* </code>
*
* @author Wei Zhuo <weizho[at]gmail[dot]com>
* @package System.Data.ActiveRecord
* @since 3.1
*/
class TActiveRecordConfig extends TDataSourceConfig
{
const DEFAULT_MANAGER_CLASS = 'System.Data.ActiveRecord.TActiveRecordManager';
const DEFAULT_GATEWAY_CLASS = 'System.Data.ActiveRecord.TActiveRecordGateway';
/**
* Defaults to {@link TActiveRecordConfig::DEFAULT_GATEWAY_CLASS DEFAULT_MANAGER_CLASS}
* @var string
*/
private $_managerClass = self::DEFAULT_MANAGER_CLASS;
/**
* Defaults to {@link TActiveRecordConfig::DEFAULT_GATEWAY_CLASS DEFAULT_GATEWAY_CLASS}
* @var string
*/
private $_gatewayClass = self::DEFAULT_GATEWAY_CLASS;
/**
* @var TActiveRecordManager
*/
private $_manager = null;
private $_enableCache=false;
/**
* Defaults to '{@link TActiveRecordInvalidFinderResult::Null Null}'
*
* @var TActiveRecordInvalidFinderResult
* @since 3.1.5
*/
private $_invalidFinderResult = TActiveRecordInvalidFinderResult::Null;
/**
* Initialize the active record manager.
* @param TXmlDocument xml configuration.
*/
public function init($xml)
{
parent::init($xml);
$manager = $this -> getManager();
if($this->getEnableCache())
$manager->setCache($this->getApplication()->getCache());
$manager->setDbConnection($this->getDbConnection());
$manager->setInvalidFinderResult($this->getInvalidFinderResult());
$manager->setGatewayClass($this->getGatewayClass());
}
/**
* @return TActiveRecordManager
*/
public function getManager() {
if($this->_manager === null)
$this->_manager = Prado::createComponent($this -> getManagerClass());
return TActiveRecordManager::getInstance($this->_manager);
}
/**
* Set implementation class of ActiveRecordManager
* @param string $value
*/
public function setManagerClass($value)
{
$this->_managerClass = TPropertyValue::ensureString($value);
}
/**
* @return string the implementation class of ActiveRecordManager. Defaults to {@link TActiveRecordConfig::DEFAULT_GATEWAY_CLASS DEFAULT_MANAGER_CLASS}
*/
public function getManagerClass()
{
return $this->_managerClass;
}
/**
* Set implementation class of ActiveRecordGateway
* @param string $value
*/
public function setGatewayClass($value)
{
$this->_gatewayClass = TPropertyValue::ensureString($value);
}
/**
* @return string the implementation class of ActiveRecordGateway. Defaults to {@link TActiveRecordConfig::DEFAULT_GATEWAY_CLASS DEFAULT_GATEWAY_CLASS}
*/
public function getGatewayClass()
{
return $this->_gatewayClass;
}
/**
* Set true to cache the table meta data.
* @param boolean true to cache sqlmap instance.
*/
public function setEnableCache($value)
{
$this->_enableCache = TPropertyValue::ensureBoolean($value);
}
/**
* @return boolean true if table meta data should be cached, false otherwise.
*/
public function getEnableCache()
{
return $this->_enableCache;
}
/**
* @return TActiveRecordInvalidFinderResult Defaults to '{@link TActiveRecordInvalidFinderResult::Null Null}'.
* @see setInvalidFinderResult
* @since 3.1.5
*/
public function getInvalidFinderResult()
{
return $this->_invalidFinderResult;
}
/**
* Define the way an active record finder react if an invalid magic-finder invoked
*
* @param TActiveRecordInvalidFinderResult
* @see getInvalidFinderResult
* @since 3.1.5
*/
public function setInvalidFinderResult($value)
{
$this->_invalidFinderResult = TPropertyValue::ensureEnum($value, 'TActiveRecordInvalidFinderResult');
}
}
|
